Back

Payment Initiation Specification

Payment Initiation API 
 4.0.0 
OAS3

https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A

Swagger for Payment Initiation API Specification

Terms of service
Contact Service Desk
open-licence
Servers

Domestic Payments

POST​/domestic-payment-consents
Create Domestic Payment Consents

Parameters

Name Description
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-idempotency-key *
string
(header)

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

x-jws-signature *
string
(header)

A detached JWS signature of the body of the payload.

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Request body

Default

{
  "Data": {
    "ReadRefundAccount": "No",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorPostalAddress": {
        "AddressType": "BIZZ",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "BuildingName": "string",
        "Floor": "string",
        "UnitNumber": "string",
        "Room": "string",
        "PostBox": "string",
        "TownLocationName": "string",
        "DistrictName": "string",
        "CareOf": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:19.936Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:19.936Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-06-17T07:17:19.936Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  }
}

Responses

Code Description Links
201

Domestic Payment Consents Created

Media type
Controls Accept header. 
{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:19.959Z",
    "Status": "AWAU",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "StatusUpdateDateTime": "2025-06-17T07:17:19.959Z",
    "ReadRefundAccount": "No",
    "CutOffDateTime": "2025-06-17T07:17:19.959Z",
    "ExpectedExecutionDateTime": "2025-06-17T07:17:19.959Z",
    "ExpectedSettlementDateTime": "2025-06-17T07:17:19.959Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorPostalAddress": {
        "AddressType": "BIZZ",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "BuildingName": "string",
        "Floor": "string",
        "UnitNumber": "string",
        "Room": "string",
        "PostBox": "string",
        "TownLocationName": "string",
        "DistrictName": "string",
        "CareOf": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:19.959Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:19.959Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-06-17T07:17:19.959Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:19.959Z",
    "LastAvailableDateTime": "2025-06-17T07:17:19.959Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/domestic-payment-consents​/{ConsentId}
Get Domestic Payment Consents

Parameters

Name Description
ConsentId *
string
(path)

ConsentId
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

Domestic Payment Consents Read

Media type
Controls Accept header. 
{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:20.009Z",
    "Status": "AWAU",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "StatusUpdateDateTime": "2025-06-17T07:17:20.009Z",
    "ReadRefundAccount": "No",
    "CutOffDateTime": "2025-06-17T07:17:20.009Z",
    "ExpectedExecutionDateTime": "2025-06-17T07:17:20.009Z",
    "ExpectedSettlementDateTime": "2025-06-17T07:17:20.009Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorPostalAddress": {
        "AddressType": "BIZZ",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "BuildingName": "string",
        "Floor": "string",
        "UnitNumber": "string",
        "Room": "string",
        "PostBox": "string",
        "TownLocationName": "string",
        "DistrictName": "string",
        "CareOf": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.009Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.009Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-06-17T07:17:20.009Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:20.009Z",
    "LastAvailableDateTime": "2025-06-17T07:17:20.009Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/domestic-payment-consents​/{ConsentId}​/funds-confirmation
Get Domestic Payment Consents Funds Confirmation

Parameters

Name Description
ConsentId *
string
(path)

ConsentId
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

Domestic Payment Consents Read

Media type
Controls Accept header. 
{
  "Data": {
    "FundsAvailableResult": {
      "FundsAvailableDateTime": "2025-06-17T07:17:20.052Z",
      "FundsAvailable": true
    },
    "SupplementaryData": {
      "additionalProp1": {}
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:20.052Z",
    "LastAvailableDateTime": "2025-06-17T07:17:20.052Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
POST​/domestic-payments
Create Domestic Payments

Parameters

Name Description
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-idempotency-key *
string
(header)

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

x-jws-signature *
string
(header)

A detached JWS signature of the body of the payload.

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Request body

Default

{
  "Data": {
    "ConsentId": "string",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorPostalAddress": {
        "AddressType": "BIZZ",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "BuildingName": "string",
        "Floor": "string",
        "UnitNumber": "string",
        "Room": "string",
        "PostBox": "string",
        "TownLocationName": "string",
        "DistrictName": "string",
        "CareOf": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.081Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.081Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  }
}

Responses

Code Description Links
201

Domestic Payments Created

Media type
Controls Accept header. 
{
  "Data": {
    "DomesticPaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:20.103Z",
    "Status": "RCVD",
    "StatusUpdateDateTime": "2025-06-17T07:17:20.103Z",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "ExpectedExecutionDateTime": "2025-06-17T07:17:20.103Z",
    "ExpectedSettlementDateTime": "2025-06-17T07:17:20.103Z",
    "Refund": {
      "Account": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      }
    },
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorPostalAddress": {
        "AddressType": "BIZZ",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "BuildingName": "string",
        "Floor": "string",
        "UnitNumber": "string",
        "Room": "string",
        "PostBox": "string",
        "TownLocationName": "string",
        "DistrictName": "string",
        "CareOf": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.103Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.103Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "MultiAuthorisation": {
      "Status": "AUTH",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2025-06-17T07:17:20.103Z",
      "ExpirationDateTime": "2025-06-17T07:17:20.103Z"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:20.103Z",
    "LastAvailableDateTime": "2025-06-17T07:17:20.103Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
409

Conflict

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/domestic-payments​/{DomesticPaymentId}
Get Domestic Payments

Parameters

Name Description
DomesticPaymentId *
string
(path)

DomesticPaymentId

x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

Domestic Payments Read

Media type
Controls Accept header. 
{
  "Data": {
    "DomesticPaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:20.152Z",
    "Status": "RCVD",
    "StatusUpdateDateTime": "2025-06-17T07:17:20.152Z",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "ExpectedExecutionDateTime": "2025-06-17T07:17:20.152Z",
    "ExpectedSettlementDateTime": "2025-06-17T07:17:20.152Z",
    "Refund": {
      "Account": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      }
    },
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorPostalAddress": {
        "AddressType": "BIZZ",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "BuildingName": "string",
        "Floor": "string",
        "UnitNumber": "string",
        "Room": "string",
        "PostBox": "string",
        "TownLocationName": "string",
        "DistrictName": "string",
        "CareOf": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.152Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.152Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "MultiAuthorisation": {
      "Status": "AUTH",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2025-06-17T07:17:20.152Z",
      "ExpirationDateTime": "2025-06-17T07:17:20.152Z"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:20.152Z",
    "LastAvailableDateTime": "2025-06-17T07:17:20.152Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links

Domestic Scheduled Payments

POST​/domestic-scheduled-payment-consents
Create Domestic Scheduled Payment Consents

Parameters

Name Description
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-idempotency-key *
string
(header)

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

x-jws-signature *
string
(header)

A detached JWS signature of the body of the payload.

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Request body

Default

{
  "Data": {
    "Permission": "Create",
    "ReadRefundAccount": "No",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "RequestedExecutionDateTime": "2025-06-17T07:17:20.199Z",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorPostalAddress": {
        "AddressType": "BIZZ",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "BuildingName": "string",
        "Floor": "string",
        "UnitNumber": "string",
        "Room": "string",
        "PostBox": "string",
        "TownLocationName": "string",
        "DistrictName": "string",
        "CareOf": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.199Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.199Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-06-17T07:17:20.199Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  }
}

Responses

Code Description Links
201

Domestic Scheduled Payment Consents Created

Media type
Controls Accept header. 
{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:20.226Z",
    "Status": "AUTH",
    "StatusUpdateDateTime": "2025-06-17T07:17:20.226Z",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "Permission": "Create",
    "ReadRefundAccount": "No",
    "CutOffDateTime": "2025-06-17T07:17:20.226Z",
    "ExpectedExecutionDateTime": "2025-06-17T07:17:20.226Z",
    "ExpectedSettlementDateTime": "2025-06-17T07:17:20.226Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "RequestedExecutionDateTime": "2025-06-17T07:17:20.226Z",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorPostalAddress": {
        "AddressType": "BIZZ",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "BuildingName": "string",
        "Floor": "string",
        "UnitNumber": "string",
        "Room": "string",
        "PostBox": "string",
        "TownLocationName": "string",
        "DistrictName": "string",
        "CareOf": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.227Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.227Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-06-17T07:17:20.227Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:20.227Z",
    "LastAvailableDateTime": "2025-06-17T07:17:20.227Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
409

Conflict

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/domestic-scheduled-payment-consents​/{ConsentId}
Get Domestic Scheduled Payment Consents

Parameters

Name Description
ConsentId *
string
(path)

ConsentId
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

Domestic Scheduled Payment Consents Read

Media type
Controls Accept header. 
{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:20.280Z",
    "Status": "AUTH",
    "StatusUpdateDateTime": "2025-06-17T07:17:20.280Z",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "Permission": "Create",
    "ReadRefundAccount": "No",
    "CutOffDateTime": "2025-06-17T07:17:20.280Z",
    "ExpectedExecutionDateTime": "2025-06-17T07:17:20.280Z",
    "ExpectedSettlementDateTime": "2025-06-17T07:17:20.280Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "RequestedExecutionDateTime": "2025-06-17T07:17:20.280Z",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorPostalAddress": {
        "AddressType": "BIZZ",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "BuildingName": "string",
        "Floor": "string",
        "UnitNumber": "string",
        "Room": "string",
        "PostBox": "string",
        "TownLocationName": "string",
        "DistrictName": "string",
        "CareOf": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.280Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.280Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-06-17T07:17:20.280Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:20.280Z",
    "LastAvailableDateTime": "2025-06-17T07:17:20.280Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
POST​/domestic-scheduled-payments
Create Domestic Scheduled Payments

Parameters

Name Description
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-idempotency-key *
string
(header)

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

x-jws-signature *
string
(header)

A detached JWS signature of the body of the payload.

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Request body

Default

{
  "Data": {
    "ConsentId": "string",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "RequestedExecutionDateTime": "2025-06-17T07:17:20.332Z",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorPostalAddress": {
        "AddressType": "BIZZ",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "BuildingName": "string",
        "Floor": "string",
        "UnitNumber": "string",
        "Room": "string",
        "PostBox": "string",
        "TownLocationName": "string",
        "DistrictName": "string",
        "CareOf": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.332Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.332Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  }
}

Responses

Code Description Links
201

Domestic Scheduled Payments Created

Media type
Controls Accept header. 
{
  "Data": {
    "DomesticScheduledPaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:20.351Z",
    "Status": "RCVD",
    "StatusUpdateDateTime": "2025-06-17T07:17:20.351Z",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "ExpectedExecutionDateTime": "2025-06-17T07:17:20.351Z",
    "ExpectedSettlementDateTime": "2025-06-17T07:17:20.351Z",
    "Refund": {
      "Account": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      }
    },
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "RequestedExecutionDateTime": "2025-06-17T07:17:20.351Z",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorPostalAddress": {
        "AddressType": "BIZZ",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "BuildingName": "string",
        "Floor": "string",
        "UnitNumber": "string",
        "Room": "string",
        "PostBox": "string",
        "TownLocationName": "string",
        "DistrictName": "string",
        "CareOf": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.351Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.351Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "MultiAuthorisation": {
      "Status": "AUTH",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2025-06-17T07:17:20.351Z",
      "ExpirationDateTime": "2025-06-17T07:17:20.351Z"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:20.351Z",
    "LastAvailableDateTime": "2025-06-17T07:17:20.351Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
409

Conflict

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/domestic-scheduled-payments​/{DomesticScheduledPaymentId}
Get Domestic Scheduled Payments

Parameters

Name Description
DomesticScheduledPaymentId *
string
(path)

DomesticScheduledPaymentId

x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

Domestic Scheduled Payments Read

Media type
Controls Accept header. 
{
  "Data": {
    "DomesticScheduledPaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:20.393Z",
    "Status": "RCVD",
    "StatusUpdateDateTime": "2025-06-17T07:17:20.393Z",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "ExpectedExecutionDateTime": "2025-06-17T07:17:20.393Z",
    "ExpectedSettlementDateTime": "2025-06-17T07:17:20.393Z",
    "Refund": {
      "Account": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      }
    },
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "RequestedExecutionDateTime": "2025-06-17T07:17:20.393Z",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorPostalAddress": {
        "AddressType": "BIZZ",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "BuildingName": "string",
        "Floor": "string",
        "UnitNumber": "string",
        "Room": "string",
        "PostBox": "string",
        "TownLocationName": "string",
        "DistrictName": "string",
        "CareOf": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "string",
        "AddressLine": [
          "string"
        ]
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.393Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.393Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "MultiAuthorisation": {
      "Status": "AUTH",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2025-06-17T07:17:20.393Z",
      "ExpirationDateTime": "2025-06-17T07:17:20.393Z"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:20.393Z",
    "LastAvailableDateTime": "2025-06-17T07:17:20.393Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links

Domestic Standing Orders

POST​/domestic-standing-order-consents
Create Domestic Standing Order Consents

Parameters

Name Description
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-idempotency-key *
string
(header)

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

x-jws-signature *
string
(header)

A detached JWS signature of the body of the payload.

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Request body

Default

{
  "Data": {
    "Permission": "Create",
    "ReadRefundAccount": "No",
    "Initiation": {
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.442Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "NumberOfPayments": "string",
      "FirstPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "RecurringPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "FinalPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.442Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "MandateRelatedInformation": {
        "MandateIdentification": "string",
        "Classification": "FIXE",
        "CategoryPurposeCode": "BONU",
        "FirstPaymentDateTime": "2025-06-17T07:17:20.442Z",
        "RecurringPaymentDateTime": "2025-06-17T07:17:20.442Z",
        "FinalPaymentDateTime": "2025-06-17T07:17:20.442Z",
        "Frequency": {
          "Type": "YEAR",
          "CountPerPeriod": 1,
          "PointInTime": "00"
        },
        "Reason": "string"
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-06-17T07:17:20.442Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  }
}

Responses

Code Description Links
201

Domestic Standing Order Consents Created

Media type
Controls Accept header. 
{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:20.462Z",
    "Status": "AUTH",
    "StatusUpdateDateTime": "2025-06-17T07:17:20.462Z",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "Permission": "Create",
    "ReadRefundAccount": "No",
    "CutOffDateTime": "2025-06-17T07:17:20.462Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.462Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "NumberOfPayments": "string",
      "FirstPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "RecurringPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "FinalPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.462Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "MandateRelatedInformation": {
        "MandateIdentification": "string",
        "Classification": "FIXE",
        "CategoryPurposeCode": "BONU",
        "FirstPaymentDateTime": "2025-06-17T07:17:20.462Z",
        "RecurringPaymentDateTime": "2025-06-17T07:17:20.462Z",
        "FinalPaymentDateTime": "2025-06-17T07:17:20.462Z",
        "Frequency": {
          "Type": "YEAR",
          "CountPerPeriod": 1,
          "PointInTime": "00"
        },
        "Reason": "string"
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-06-17T07:17:20.462Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:20.462Z",
    "LastAvailableDateTime": "2025-06-17T07:17:20.462Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
409

Conflict

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/domestic-standing-order-consents​/{ConsentId}
Get Domestic Standing Order Consents

Parameters

Name Description
ConsentId *
string
(path)

ConsentId
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

Domestic Standing Order Consents Read

Media type
Controls Accept header. 
{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:20.512Z",
    "Status": "AUTH",
    "StatusUpdateDateTime": "2025-06-17T07:17:20.512Z",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "Permission": "Create",
    "ReadRefundAccount": "No",
    "CutOffDateTime": "2025-06-17T07:17:20.512Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.512Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "NumberOfPayments": "string",
      "FirstPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "RecurringPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "FinalPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.513Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "MandateRelatedInformation": {
        "MandateIdentification": "string",
        "Classification": "FIXE",
        "CategoryPurposeCode": "BONU",
        "FirstPaymentDateTime": "2025-06-17T07:17:20.513Z",
        "RecurringPaymentDateTime": "2025-06-17T07:17:20.513Z",
        "FinalPaymentDateTime": "2025-06-17T07:17:20.513Z",
        "Frequency": {
          "Type": "YEAR",
          "CountPerPeriod": 1,
          "PointInTime": "00"
        },
        "Reason": "string"
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-06-17T07:17:20.513Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:20.513Z",
    "LastAvailableDateTime": "2025-06-17T07:17:20.513Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
POST​/domestic-standing-orders
Create Domestic Standing Orders

Parameters

Name Description
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-idempotency-key *
string
(header)

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

x-jws-signature *
string
(header)

A detached JWS signature of the body of the payload.

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Request body

Default

{
  "Data": {
    "ConsentId": "string",
    "Initiation": {
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.558Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "NumberOfPayments": "string",
      "FirstPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "RecurringPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "FinalPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.558Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "MandateRelatedInformation": {
        "MandateIdentification": "string",
        "Classification": "FIXE",
        "CategoryPurposeCode": "BONU",
        "FirstPaymentDateTime": "2025-06-17T07:17:20.558Z",
        "RecurringPaymentDateTime": "2025-06-17T07:17:20.558Z",
        "FinalPaymentDateTime": "2025-06-17T07:17:20.558Z",
        "Frequency": {
          "Type": "YEAR",
          "CountPerPeriod": 1,
          "PointInTime": "00"
        },
        "Reason": "string"
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  }
}

Responses

Code Description Links
201

Domestic Standing Orders Created

Media type
Controls Accept header. 
{
  "Data": {
    "DomesticStandingOrderId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:20.577Z",
    "Status": "RCVD",
    "StatusUpdateDateTime": "2025-06-17T07:17:20.577Z",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "Refund": {
      "Account": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      }
    },
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.577Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "NumberOfPayments": "string",
      "FirstPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "RecurringPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "FinalPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.577Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "MandateRelatedInformation": {
        "MandateIdentification": "string",
        "Classification": "FIXE",
        "CategoryPurposeCode": "BONU",
        "FirstPaymentDateTime": "2025-06-17T07:17:20.577Z",
        "RecurringPaymentDateTime": "2025-06-17T07:17:20.577Z",
        "FinalPaymentDateTime": "2025-06-17T07:17:20.577Z",
        "Frequency": {
          "Type": "YEAR",
          "CountPerPeriod": 1,
          "PointInTime": "00"
        },
        "Reason": "string"
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "MultiAuthorisation": {
      "Status": "AUTH",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2025-06-17T07:17:20.577Z",
      "ExpirationDateTime": "2025-06-17T07:17:20.577Z"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:20.577Z",
    "LastAvailableDateTime": "2025-06-17T07:17:20.577Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
409

Conflict

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/domestic-standing-orders​/{DomesticStandingOrderId}
Get Domestic Standing Orders

Parameters

Name Description
DomesticStandingOrderId *
string
(path)

DomesticStandingOrderId

x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

Domestic Standing Orders Read

Media type
Controls Accept header. 
{
  "Data": {
    "DomesticStandingOrderId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:20.622Z",
    "Status": "RCVD",
    "StatusUpdateDateTime": "2025-06-17T07:17:20.622Z",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "Refund": {
      "Account": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      }
    },
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.622Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "NumberOfPayments": "string",
      "FirstPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "RecurringPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "FinalPaymentAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.622Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "MandateRelatedInformation": {
        "MandateIdentification": "string",
        "Classification": "FIXE",
        "CategoryPurposeCode": "BONU",
        "FirstPaymentDateTime": "2025-06-17T07:17:20.622Z",
        "RecurringPaymentDateTime": "2025-06-17T07:17:20.622Z",
        "FinalPaymentDateTime": "2025-06-17T07:17:20.622Z",
        "Frequency": {
          "Type": "YEAR",
          "CountPerPeriod": 1,
          "PointInTime": "00"
        },
        "Reason": "string"
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "MultiAuthorisation": {
      "Status": "AUTH",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2025-06-17T07:17:20.622Z",
      "ExpirationDateTime": "2025-06-17T07:17:20.622Z"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:20.622Z",
    "LastAvailableDateTime": "2025-06-17T07:17:20.622Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links

File Payments

POST​/file-payment-consents
Create File Payment Consents

Parameters

Name Description
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-idempotency-key *
string
(header)

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

x-jws-signature *
string
(header)

A detached JWS signature of the body of the payload.

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Request body

Default

{
  "Data": {
    "Initiation": {
      "FileType": "string",
      "FileHash": "string",
      "FileReference": "string",
      "NumberOfTransactions": "string",
      "ControlSum": 0,
      "RequestedExecutionDateTime": "2025-06-17T07:17:20.662Z",
      "LocalInstrument": "string",
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.662Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-06-17T07:17:20.662Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  }
}

Responses

Code Description Links
201

File Payment Consents Created

Media type
Controls Accept header. 
{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:20.678Z",
    "Status": "AWAU",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "StatusUpdateDateTime": "2025-06-17T07:17:20.678Z",
    "CutOffDateTime": "2025-06-17T07:17:20.678Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "FileType": "string",
      "FileHash": "string",
      "FileReference": "string",
      "NumberOfTransactions": "string",
      "ControlSum": 0,
      "RequestedExecutionDateTime": "2025-06-17T07:17:20.678Z",
      "LocalInstrument": "string",
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.678Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-06-17T07:17:20.678Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:20.678Z",
    "LastAvailableDateTime": "2025-06-17T07:17:20.678Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
409

Conflict

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/file-payment-consents​/{ConsentId}
Get File Payment Consents

Parameters

Name Description
ConsentId *
string
(path)

ConsentId
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

File Payment Consents Read

Media type
Controls Accept header. 
{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:20.714Z",
    "Status": "AWAU",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "StatusUpdateDateTime": "2025-06-17T07:17:20.714Z",
    "CutOffDateTime": "2025-06-17T07:17:20.714Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "FileType": "string",
      "FileHash": "string",
      "FileReference": "string",
      "NumberOfTransactions": "string",
      "ControlSum": 0,
      "RequestedExecutionDateTime": "2025-06-17T07:17:20.714Z",
      "LocalInstrument": "string",
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.714Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-06-17T07:17:20.714Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:20.714Z",
    "LastAvailableDateTime": "2025-06-17T07:17:20.714Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
POST​/file-payment-consents​/{ConsentId}​/file
Create File Payment Consents

Parameters

Name Description
ConsentId *
string
(path)

ConsentId
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-idempotency-key *
string
(header)

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

x-jws-signature *
string
(header)

A detached JWS signature of the body of the payload.

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Request body

Default

{}

Responses

Code Description Links
200

File Payment Consents Created

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
409

Conflict

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/file-payment-consents​/{ConsentId}​/file
Get File Payment Consents

Parameters

Name Description
ConsentId *
string
(path)

ConsentId
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

File Payment Consents Read

Media type
Controls Accept header. 
{}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
POST​/file-payments
Create File Payments

Parameters

Name Description
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-idempotency-key *
string
(header)

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

x-jws-signature *
string
(header)

A detached JWS signature of the body of the payload.

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Request body

Default

{
  "Data": {
    "ConsentId": "string",
    "Initiation": {
      "FileType": "string",
      "FileHash": "string",
      "FileReference": "string",
      "NumberOfTransactions": "string",
      "ControlSum": 0,
      "RequestedExecutionDateTime": "2025-06-17T07:17:20.787Z",
      "LocalInstrument": "string",
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.787Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    }
  }
}

Responses

Code Description Links
201

File Payments Created

Media type
Controls Accept header. 
{
  "Data": {
    "FilePaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:20.798Z",
    "Status": "INFA",
    "StatusUpdateDateTime": "2025-06-17T07:17:20.798Z",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "FileType": "string",
      "FileHash": "string",
      "FileReference": "string",
      "NumberOfTransactions": "string",
      "ControlSum": 0,
      "RequestedExecutionDateTime": "2025-06-17T07:17:20.798Z",
      "LocalInstrument": "string",
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.798Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "MultiAuthorisation": {
      "Status": "AUTH",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2025-06-17T07:17:20.798Z",
      "ExpirationDateTime": "2025-06-17T07:17:20.798Z"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:20.798Z",
    "LastAvailableDateTime": "2025-06-17T07:17:20.798Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
409

Conflict

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/file-payments​/{FilePaymentId}
Get File Payments

Parameters

Name Description
FilePaymentId *
string
(path)

FilePaymentId
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

File Payments Read

Media type
Controls Accept header. 
{
  "Data": {
    "FilePaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:20.832Z",
    "Status": "INFA",
    "StatusUpdateDateTime": "2025-06-17T07:17:20.832Z",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "Initiation": {
      "FileType": "string",
      "FileHash": "string",
      "FileReference": "string",
      "NumberOfTransactions": "string",
      "ControlSum": 0,
      "RequestedExecutionDateTime": "2025-06-17T07:17:20.833Z",
      "LocalInstrument": "string",
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.833Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "MultiAuthorisation": {
      "Status": "AUTH",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2025-06-17T07:17:20.833Z",
      "ExpirationDateTime": "2025-06-17T07:17:20.833Z"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:20.833Z",
    "LastAvailableDateTime": "2025-06-17T07:17:20.833Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/file-payments​/{FilePaymentId}​/report-file
Get File Payments

Parameters

Name Description
FilePaymentId *
string
(path)

FilePaymentId
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

File Payments Read

Media type
Controls Accept header. 
{}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links

International Payments

POST​/international-payment-consents
Create International Payment Consents

Parameters

Name Description
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-idempotency-key *
string
(header)

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

x-jws-signature *
string
(header)

A detached JWS signature of the body of the payload.

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Request body

Default

{
  "Data": {
    "ReadRefundAccount": "No",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "ExtendedPurpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "CurrencyOfTransfer": "string",
      "DestinationCountryCode": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "Creditor": {
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.890Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.890Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-06-17T07:17:20.890Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  }
}

Responses

Code Description Links
201

International Payment Consents Created

Media type
Controls Accept header. 
{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:20.914Z",
    "Status": "AWAU",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "StatusUpdateDateTime": "2025-06-17T07:17:20.914Z",
    "ReadRefundAccount": "No",
    "CutOffDateTime": "2025-06-17T07:17:20.914Z",
    "ExpectedExecutionDateTime": "2025-06-17T07:17:20.914Z",
    "ExpectedSettlementDateTime": "2025-06-17T07:17:20.914Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "ExchangeRateInformation": {
      "UnitCurrency": "string",
      "ExchangeRate": 0,
      "RateType": "Actual",
      "ContractIdentification": "string",
      "ExpirationDateTime": "2025-06-17T07:17:20.914Z"
    },
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "ExtendedPurpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "CurrencyOfTransfer": "string",
      "DestinationCountryCode": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "Creditor": {
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.914Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.914Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-06-17T07:17:20.914Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:20.915Z",
    "LastAvailableDateTime": "2025-06-17T07:17:20.915Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
409

Conflict

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/international-payment-consents​/{ConsentId}
Get International Payment Consents

Parameters

Name Description
ConsentId *
string
(path)

ConsentId
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

International Payment Consents Read

Media type
Controls Accept header. 
{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:20.970Z",
    "Status": "AWAU",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "StatusUpdateDateTime": "2025-06-17T07:17:20.970Z",
    "ReadRefundAccount": "No",
    "CutOffDateTime": "2025-06-17T07:17:20.970Z",
    "ExpectedExecutionDateTime": "2025-06-17T07:17:20.970Z",
    "ExpectedSettlementDateTime": "2025-06-17T07:17:20.970Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "ExchangeRateInformation": {
      "UnitCurrency": "string",
      "ExchangeRate": 0,
      "RateType": "Actual",
      "ContractIdentification": "string",
      "ExpirationDateTime": "2025-06-17T07:17:20.970Z"
    },
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "ExtendedPurpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "CurrencyOfTransfer": "string",
      "DestinationCountryCode": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "Creditor": {
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:20.970Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:20.970Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-06-17T07:17:20.970Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:20.970Z",
    "LastAvailableDateTime": "2025-06-17T07:17:20.970Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/international-payment-consents​/{ConsentId}​/funds-confirmation
Get International Payment Consents Funds Confirmation

Parameters

Name Description
ConsentId *
string
(path)

ConsentId
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

International Payment Consents Read

Media type
Controls Accept header. 
{
  "Data": {
    "FundsAvailableResult": {
      "FundsAvailableDateTime": "2025-06-17T07:17:21.014Z",
      "FundsAvailable": true
    },
    "SupplementaryData": {
      "additionalProp1": {}
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:21.014Z",
    "LastAvailableDateTime": "2025-06-17T07:17:21.014Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
POST​/international-payments
Create International Payments

Parameters

Name Description
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-idempotency-key *
string
(header)

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

x-jws-signature *
string
(header)

A detached JWS signature of the body of the payload.

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Request body

Default

{
  "Data": {
    "ConsentId": "string",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "ExtendedPurpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "CurrencyOfTransfer": "string",
      "DestinationCountryCode": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "Creditor": {
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:21.045Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:21.045Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  }
}

Responses

Code Description Links
201

International Payments Created

Media type
Controls Accept header. 
{
  "Data": {
    "InternationalPaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:21.068Z",
    "Status": "RCVD",
    "StatusUpdateDateTime": "2025-06-17T07:17:21.068Z",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "ExpectedExecutionDateTime": "2025-06-17T07:17:21.068Z",
    "ExpectedSettlementDateTime": "2025-06-17T07:17:21.068Z",
    "Refund": {
      "Creditor": {
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "Agent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "Account": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      }
    },
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "ExchangeRateInformation": {
      "UnitCurrency": "string",
      "ExchangeRate": 0,
      "RateType": "Actual",
      "ContractIdentification": "string",
      "ExpirationDateTime": "2025-06-17T07:17:21.069Z"
    },
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "ExtendedPurpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "CurrencyOfTransfer": "string",
      "DestinationCountryCode": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "Creditor": {
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:21.069Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:21.069Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "MultiAuthorisation": {
      "Status": "AUTH",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2025-06-17T07:17:21.069Z",
      "ExpirationDateTime": "2025-06-17T07:17:21.069Z"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:21.069Z",
    "LastAvailableDateTime": "2025-06-17T07:17:21.069Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/international-payments​/{InternationalPaymentId}
Get International Payments

Parameters

Name Description
InternationalPaymentId *
string
(path)

InternationalPaymentId

x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

International Payments Read

Media type
Controls Accept header. 
{
  "Data": {
    "InternationalPaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:21.126Z",
    "Status": "RCVD",
    "StatusUpdateDateTime": "2025-06-17T07:17:21.126Z",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "ExpectedExecutionDateTime": "2025-06-17T07:17:21.126Z",
    "ExpectedSettlementDateTime": "2025-06-17T07:17:21.126Z",
    "Refund": {
      "Creditor": {
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "Agent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "Account": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      }
    },
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "ExchangeRateInformation": {
      "UnitCurrency": "string",
      "ExchangeRate": 0,
      "RateType": "Actual",
      "ContractIdentification": "string",
      "ExpirationDateTime": "2025-06-17T07:17:21.126Z"
    },
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "ExtendedPurpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "CurrencyOfTransfer": "string",
      "DestinationCountryCode": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "Creditor": {
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:21.126Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:21.126Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "MultiAuthorisation": {
      "Status": "AUTH",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2025-06-17T07:17:21.126Z",
      "ExpirationDateTime": "2025-06-17T07:17:21.126Z"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:21.126Z",
    "LastAvailableDateTime": "2025-06-17T07:17:21.126Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links

International Scheduled Payments

POST​/international-scheduled-payment-consents
Create International Scheduled Payment Consents

Parameters

Name Description
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-idempotency-key *
string
(header)

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

x-jws-signature *
string
(header)

A detached JWS signature of the body of the payload.

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Request body

Default

{
  "Data": {
    "Permission": "Create",
    "ReadRefundAccount": "No",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "ExtendedPurpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "RequestedExecutionDateTime": "2025-06-17T07:17:21.182Z",
      "CurrencyOfTransfer": "string",
      "DestinationCountryCode": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "Creditor": {
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:21.182Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:21.182Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-06-17T07:17:21.182Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  }
}

Responses

Code Description Links
201

International Scheduled Payment Consents Created

Media type
Controls Accept header. 
{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:21.210Z",
    "Status": "AWAU",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "StatusUpdateDateTime": "2025-06-17T07:17:21.210Z",
    "Permission": "Create",
    "ReadRefundAccount": "No",
    "CutOffDateTime": "2025-06-17T07:17:21.210Z",
    "ExpectedExecutionDateTime": "2025-06-17T07:17:21.210Z",
    "ExpectedSettlementDateTime": "2025-06-17T07:17:21.210Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "ExchangeRateInformation": {
      "UnitCurrency": "string",
      "ExchangeRate": 0,
      "RateType": "Actual",
      "ContractIdentification": "string",
      "ExpirationDateTime": "2025-06-17T07:17:21.210Z"
    },
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "ExtendedPurpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "RequestedExecutionDateTime": "2025-06-17T07:17:21.210Z",
      "CurrencyOfTransfer": "string",
      "DestinationCountryCode": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "Creditor": {
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:21.210Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:21.210Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-06-17T07:17:21.210Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:21.210Z",
    "LastAvailableDateTime": "2025-06-17T07:17:21.210Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
409

Conflict

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/international-scheduled-payment-consents​/{ConsentId}
Get International Scheduled Payment Consents

Parameters

Name Description
ConsentId *
string
(path)

ConsentId
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

International Scheduled Payment Consents Read

Media type
Controls Accept header. 
{
  "Data": {
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:21.262Z",
    "Status": "AWAU",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "StatusUpdateDateTime": "2025-06-17T07:17:21.262Z",
    "Permission": "Create",
    "ReadRefundAccount": "No",
    "CutOffDateTime": "2025-06-17T07:17:21.262Z",
    "ExpectedExecutionDateTime": "2025-06-17T07:17:21.262Z",
    "ExpectedSettlementDateTime": "2025-06-17T07:17:21.262Z",
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "ExchangeRateInformation": {
      "UnitCurrency": "string",
      "ExchangeRate": 0,
      "RateType": "Actual",
      "ContractIdentification": "string",
      "ExpirationDateTime": "2025-06-17T07:17:21.262Z"
    },
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "ExtendedPurpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "RequestedExecutionDateTime": "2025-06-17T07:17:21.262Z",
      "CurrencyOfTransfer": "string",
      "DestinationCountryCode": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "Creditor": {
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:21.262Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:21.262Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "Authorisation": {
      "AuthorisationType": "Any",
      "CompletionDateTime": "2025-06-17T07:17:21.262Z"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": "BillPayment",
      "AppliedAuthenticationApproach": "CA",
      "ReferencePaymentOrderId": "string"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:21.262Z",
    "LastAvailableDateTime": "2025-06-17T07:17:21.262Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/international-scheduled-payment-consents​/{ConsentId}​/funds-confirmation
Get International Scheduled Payment Consents Funds Confirmation

Parameters

Name Description
ConsentId *
string
(path)

ConsentId
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

International Scheduled Payment Consents Read

Media type
Controls Accept header. 
{
  "Data": {
    "FundsAvailableResult": {
      "FundsAvailableDateTime": "2025-06-17T07:17:21.311Z",
      "FundsAvailable": true
    },
    "SupplementaryData": {
      "additionalProp1": {}
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:21.311Z",
    "LastAvailableDateTime": "2025-06-17T07:17:21.311Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
POST​/international-scheduled-payments
Create International Scheduled Payments

Parameters

Name Description
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-idempotency-key *
string
(header)

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

x-jws-signature *
string
(header)

A detached JWS signature of the body of the payload.

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Request body

Default

{
  "Data": {
    "ConsentId": "string",
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "ExtendedPurpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "RequestedExecutionDateTime": "2025-06-17T07:17:21.336Z",
      "CurrencyOfTransfer": "string",
      "DestinationCountryCode": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "Creditor": {
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:21.336Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:21.336Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentIndicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "BKDF",
    "CategoryPurposeCode": "BONU",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressType": "BIZZ",
      "Department": "string",
      "SubDepartment": "string",
      "StreetName": "string",
      "BuildingNumber": "string",
      "BuildingName": "string",
      "Floor": "string",
      "UnitNumber": "string",
      "Room": "string",
      "PostBox": "string",
      "TownLocationName": "string",
      "DistrictName": "string",
      "CareOf": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "string",
      "AddressLine": [
        "string"
      ]
    }
  }
}

Responses

Code Description Links
201

International Scheduled Payments Created

Media type
Controls Accept header. 
{
  "Data": {
    "InternationalScheduledPaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:21.363Z",
    "Status": "RCVD",
    "StatusUpdateDateTime": "2025-06-17T07:17:21.363Z",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "ExpectedExecutionDateTime": "2025-06-17T07:17:21.363Z",
    "ExpectedSettlementDateTime": "2025-06-17T07:17:21.363Z",
    "Refund": {
      "Creditor": {
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "Agent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "Account": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      }
    },
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "ExchangeRateInformation": {
      "UnitCurrency": "string",
      "ExchangeRate": 0,
      "RateType": "Actual",
      "ContractIdentification": "string",
      "ExpirationDateTime": "2025-06-17T07:17:21.363Z"
    },
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "ExtendedPurpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "RequestedExecutionDateTime": "2025-06-17T07:17:21.363Z",
      "CurrencyOfTransfer": "string",
      "DestinationCountryCode": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "Creditor": {
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:21.364Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:21.364Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "MultiAuthorisation": {
      "Status": "AUTH",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2025-06-17T07:17:21.364Z",
      "ExpirationDateTime": "2025-06-17T07:17:21.364Z"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:21.364Z",
    "LastAvailableDateTime": "2025-06-17T07:17:21.364Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
409

Conflict

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/international-scheduled-payments​/{InternationalScheduledPaymentId}
Get International Scheduled Payments

Parameters

Name Description
InternationalScheduledPaymentId *
string
(path)

InternationalScheduledPaymentId

x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

International Scheduled Payments Read

Media type
Controls Accept header. 
{
  "Data": {
    "InternationalScheduledPaymentId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:17:21.417Z",
    "Status": "RCVD",
    "StatusUpdateDateTime": "2025-06-17T07:17:21.417Z",
    "StatusReason": [
      {
        "StatusReasonCode": "ERIN",
        "StatusReasonDescription": "string",
        "Path": "string"
      }
    ],
    "ExpectedExecutionDateTime": "2025-06-17T07:17:21.417Z",
    "ExpectedSettlementDateTime": "2025-06-17T07:17:21.417Z",
    "Refund": {
      "Creditor": {
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "Agent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "Account": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string"
      }
    },
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ],
    "ExchangeRateInformation": {
      "UnitCurrency": "string",
      "ExchangeRate": 0,
      "RateType": "Actual",
      "ContractIdentification": "string",
      "ExpirationDateTime": "2025-06-17T07:17:21.417Z"
    },
    "Initiation": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "LocalInstrument": "string",
      "InstructionPriority": "Normal",
      "ExtendedPurpose": "string",
      "ChargeBearer": "BorneByCreditor",
      "RequestedExecutionDateTime": "2025-06-17T07:17:21.417Z",
      "CurrencyOfTransfer": "string",
      "DestinationCountryCode": "string",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "string"
      },
      "ExchangeRateInformation": {
        "UnitCurrency": "string",
        "ExchangeRate": 0,
        "RateType": "Actual",
        "ContractIdentification": "string"
      },
      "DebtorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "Creditor": {
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAgent": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "LEI": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "CreditorAccount": {
        "SchemeName": "string",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "string",
        "Proxy": {
          "Identification": "string",
          "Code": "TELE",
          "Type": "string"
        }
      },
      "UltimateCreditor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "UltimateDebtor": {
        "Name": "string",
        "Identification": "string",
        "LEI": "string",
        "SchemeName": "string",
        "PostalAddress": {
          "AddressType": "BIZZ",
          "Department": "string",
          "SubDepartment": "string",
          "StreetName": "string",
          "BuildingNumber": "string",
          "BuildingName": "string",
          "Floor": "string",
          "UnitNumber": "string",
          "Room": "string",
          "PostBox": "string",
          "TownLocationName": "string",
          "DistrictName": "string",
          "CareOf": "string",
          "PostCode": "string",
          "TownName": "string",
          "CountrySubDivision": "string",
          "Country": "string",
          "AddressLine": [
            "string"
          ]
        }
      },
      "RegulatoryReporting": [
        {
          "DebitCreditReportingIndicator": "CRED",
          "Authority": {
            "Name": "string",
            "CountryCode": "string"
          },
          "Details": [
            {
              "Type": "string",
              "Date": "2025-06-17T07:17:21.417Z",
              "Country": "string",
              "Amount": {
                "Amount": "string",
                "Currency": "string"
              },
              "Information": [
                "string"
              ]
            }
          ]
        }
      ],
      "RemittanceInformation": {
        "Structured": [
          {
            "ReferredDocumentInformation": [
              {
                "Code": "CINV",
                "Issuer": "string",
                "Number": "string",
                "RelatedDate": "2025-06-17T07:17:21.417Z",
                "LineDetails": [
                  "string"
                ]
              }
            ],
            "ReferredDocumentAmount": 0,
            "CreditorReferenceInformation": {
              "Code": "DISP",
              "Issuer": "string",
              "Reference": "string"
            },
            "Invoicer": "80200112344562",
            "Invoicee": "80200112344562",
            "TaxRemittance": "string",
            "AdditionalRemittanceInformation": [
              "string"
            ]
          }
        ],
        "Unstructured": [
          "string"
        ]
      },
      "SupplementaryData": {
        "additionalProp1": {}
      }
    },
    "MultiAuthorisation": {
      "Status": "AUTH",
      "NumberRequired": 0,
      "NumberReceived": 0,
      "LastUpdateDateTime": "2025-06-17T07:17:21.417Z",
      "ExpirationDateTime": "2025-06-17T07:17:21.417Z"
    },
    "Debtor": {
      "SchemeName": "string",
      "Identification": "string",
      "Name": "string",
      "SecondaryIdentification": "string",
      "LEI": "string"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2025-06-17T07:17:21.417Z",
    "LastAvailableDateTime": "2025-06-17T07:17:21.417Z"
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
404

Not found

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Id": "string",
  "Code": "400 BadRequest",
  "Message": "There is something wrong with the request parameters provided",
  "Errors": [
    {
      "ErrorCode": "U001",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links

Schemas

NumberOfPaymentsstring
minLength: 1
maxLength: 35

Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.

Frequency1string
pattern: ^(NotKnown)$|^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$

Individual Definitions: NotKnown - Not Known EvryDay - Every day EvryWorkgDay - Every working day IntrvlDay - An interval specified in number of calendar days (02 to 31) IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-05 to -01, 01 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED) ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: NotKnown (ScheduleCode) EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlDay:NoOfDay (ScheduleCode + NoOfDay) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: NotKnown EvryDay EvryWorkgDay IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]) IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) QtrDay:(ENGLISH|SCOTTISH|RECEIVED) Full Regular Expression: ^(NotKnown)$|^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$

OBUltimateCreditor1{
description:

Ultimate party to which an amount of money is due.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
OBUltimateDebtor1{
description:

Ultimate party that owes an amount of money to the (ultimate) creditor.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
OBFrequency6{
description:

Regularity with which credit transfer instructions are to be created and processed

Type* OBFrequency6Codestring

OBFrequency6Code on External Codset Repo

Enum:
Array [ 10 ]
CountPerPeriod integer($int32)
example: 1

Number of instructions to be created and processed during the specified period .Specifies a frequency in terms of a count per period within a specified frequency type. Note: should not be used alongside PointInTime

PointInTime PointInTimestring
example: 00
maxLength: 2

Exact2NumericText - Further information on the exact point in time the event should take place. Specifies a frequency in terms of an exact point in time or moment within a specified frequency type. Note: should not be used alongside CountPerSide

}
PointInTimestring
example: 00
maxLength: 2

Exact2NumericText - Further information on the exact point in time the event should take place. Specifies a frequency in terms of an exact point in time or moment within a specified frequency type. Note: should not be used alongside CountPerSide

ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.
BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

Datestring($date)

Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO 8601 date format. An example is below: 2017-04-05

ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
[ BONU, CASH, CBLK, CCRD, CGWV, CIPC, CONC, CORT, DCRD, DIVI, DVPM, EPAY, FCDT, FCIN, FCOL, GOVT, GP2P, HEDG, ICCP, IDCP, INTC, INTE, LBOX, LOAN, MP2B, MP2P, OTHR, PENS, RPRE, RRCT, RVPM, SALA, SECU, SSBE, SUPP, SWEP, TAXS, TOPG, TRAD, TREA, VATX, VOST, WHLD, ZABA ]
CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.
CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

File{
}
Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Identification_1string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Identification_3string
example: 80200112344562
minLength: 1
maxLength: 256

Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor

Identification_4string
example: 80200112344562
minLength: 1
maxLength: 256

Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.

LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

MetaData{
description:

Meta Data relevant to the payload

TotalPages integer($int32)
FirstAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
Namestring
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

OBActiveOrHistoricCurrencyAndAmount{
description:

Amount of money associated with the charge type.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
OBAddressTypeCodestring

Identifies the nature of the postal address.

Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
OBBranchAndFinancialInstitutionIdentification6_0{
description:

Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.

SchemeName OBInternalFinancialInstitutionIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list.

Identification Identification_1string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name Namestring
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

}
OBInternalChargeBearerType1Codestring

Specifies which party/parties will bear the charges associated with the processing of the payment transaction. For a full list of values refer to OBInternalChargeBearerType1Code in OB_Internal_CodeSet here

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
OBCashAccountCreditor3{
SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* string
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string

Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
maxLength: 34

Secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
Array [ 21 ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
OBCashAccountDebtor4{
description:

^ Only included in the response if Data. ReadRefundAccount is set to Yes in the consent.

SchemeName string

^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBInternalAccountIdentification4Code

Identification string

^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text

Name string

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

}
OBExternalMandateClassification1CodestringEnum:
[ FIXE, USGB, VARI ]
OBError1{
ErrorCode* OBInternalErrorResponseError1Codestring
minLength: 4
maxLength: 4
example: U001

Low level textual error code, for all enum values see OBInternalErrorResponseError1Code here

Message string
minLength: 1
maxLength: 500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBL doesn't standardise this field

Path string
minLength: 1
maxLength: 500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
minProperties: 1
OBErrorResponse1{
description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Id string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Code string
minLength: 1
example: 400 BadRequest
maxLength: 40

Deprecated
High level textual error code, to help categorise the errors.

Message string
minLength: 1
example: There is something wrong with the request parameters provided
maxLength: 500

Deprecated
Brief Error message

Errors* [
minItems: 1
https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBError1OBError1{
ErrorCode* OBInternalErrorResponseError1Codestring
minLength: 4
maxLength: 4
example: U001

Low level textual error code, for all enum values see OBInternalErrorResponseError1Code here

Message string
minLength: 1
maxLength: 500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBL doesn't standardise this field

Path string
minLength: 1
maxLength: 500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
minProperties: 1]
}
OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

ExternalCreditorReferenceType1Codestring
minLength: 1
maxLength: 4

Specifies the type of creditor reference as published in an external creditor reference type code set. For more information see ExternalCreditorReferenceType1Code in ISO_External_CodeSet here

Enum:
[ DISP, FXDR, PUOR, RPIN, RADM, SCOR ]
ExternalDocumentType1Codestring
minLength: 1
maxLength: 4

Specifies the document type as published in an external document type code list. For more information see ExternalDocumentType1Code in ISO_External_CodeSet here

Enum:
[ CINV, CNFA, CONT, CREN, DEBN, DISP, DNFA, HIRI, INVS, MSIN, PROF, PUOR, QUOT, SBIN, SPRR, TISH ]
OBInternalFinancialInstitutionIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list.

OBInternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
[ Business, BusinessSavingsAccount, Charity, Collection, Corporate, Ewallet, Government, Investment, ISA, JointPersonal, Pension, Personal, PersonalSavingsAccount, Premier, Wealth ]
OBInternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. For a full list of values refer to OBInternalLocalInstrument1Code in OB_Internal_CodeSet here

OBInternalPaymentChargeType1Codestring

Charge type, in a coded form. For a full list of values refer to OBInternalPaymentChargeType1Code in OB_Internal_CodeSet here

ExternalPurpose1Codestring
minLength: 1
maxLength: 4

This is a partial list, For a full list see ExternalPurpose1Code here

Enum:
[ BKDF, BKFE, BKFM, BKIP, BKPP, CBLK, CDCB, CDCD, CDCS, CDDP, CDOC, CDQC, ETUP, FCOL, MTUP, ACCT, CASH, COLL, CSDB, DEPT, INTC, INTP, LIMA, NETT, BFWD, CCIR, CCPC, CCPM, CCSM, CRDS, CRPR, CRSP, CRTL, EQPT, EQUS, EXPT, EXTD, FIXI, FWBC, FWCC, FWSB, FWSC, MARG, MBSB, MBSC, MGCC, MGSC, OCCC, OPBC, OPCC, OPSB, OPSC, OPTN, OTCD, REPO, RPBC, RPCC, RPSB, RPSC, RVPO, SBSC, SCIE, SCIR, SCRP, SHBC, SHCC, SHSL, SLEB, SLOA, SWBC, SWCC, SWPT, SWSB, SWSC, TBAS, TBBC, TBCC, TRCP, AGRT, AREN, BEXP, BOCE, COMC, CPYR, GDDS, GDSV, GSCB, LICF, MP2B, POPE, ROYA, SCVE, SERV, SUBS, SUPP, TRAD, CHAR, COMT, MP2P, ECPG, ECPR, ECPU, EPAY, CLPR, COMP, DBTC, GOVI, HLRP, HLST, INPC, INPR, INSC, INSU, INTE, LBRI, LIFI, LOAN, LOAR, PENO, PPTI, RELG, RINP, TRFD, FORW, FXNT, ADMG, ADVA, BCDM, BCFG, BLDM, BNET, CBFF, CBFR, CCRD, CDBL, CFEE, CGDD, CORT, COST, CPKC, DCRD, DSMT, DVPM, EDUC, FACT, FAND, FCPM, FEES, GIFT, GOVT, ICCP, IDCP, IHRP, INSM, IVPT, MCDM, MCFG, MSVC, NOWS, OCDM, OCFG, OFEE, OTHR, PADD, PTSP, RCKE, RCPT, REBT, REFU, RENT, REOD, RIMB, RPNT, RRBN, RRCT, RRTP, RVPM, SLPI, SPLT, STDY, TBAN, TBIL, TCSC, TELI, TMPG, TPRI, TPRP, TRNC, TRVC, WEBI, IPAY, IPCA, IPDO, IPEA, IPEC, IPEW, IPPS, IPRT, IPU2, IPUW, ANNI, CAFI, CFDI, CMDT, DERI, DIVD, FREX, HEDG, INVS, PRME, SAVG, SECU, SEPI, TREA, UNIT, FNET, FUTR, ANTS, CVCF, DMEQ, DNTS, HLTC, HLTI, HSPC, ICRF, LTCF, MAFC, MARF, MDCS, VIEW, CDEP, SWFP, SWPP, SWRS, SWUF, ADCS, AEMP, ALLW, ALMY, BBSC, BECH, BENE, BONU, CCHD, COMM, CSLP, GFRP, GVEA, GVEB, GVEC, GVED, GWLT, HREC, PAYR, PEFC, PENS, PRCP, RHBS, SALA, SPSP, SSBE, LBIN, LCOL, LFEE, LMEQ, LMFI, LMRK, LREB, LREV, LSFL, ESTX, FWLV, GSTX, HSTX, INTX, NITX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, B112, BR12, TLRF, TLRR, AIRB, BUSB, FERB, RLWY, TRPT, CBTV, ELEC, ENRG, GASB, NWCH, NWCM, OTLC, PHON, UBIL, WTER, BOND, CABD, CAEQ, CBCR, DBCR, DICL, EQTS, FLCR, EFTC, EFTD, MOMA, RAPI, GAMB, LOTT, AMEX, SASW, AUCO, PCOM, PDEP, PLDS, PLRF, GAFA, GAHO, CPEN, DEPD, RETL, DEBT ]
OBInternalErrorResponseError1Codestring
minLength: 4
maxLength: 4
example: U001

Low level textual error code, for all enum values see OBInternalErrorResponseError1Code here

OBFrequency6Codestring

OBFrequency6Code on External Codset Repo

Enum:
[ YEAR, FRTN, MNTH, QURT, MIAN, WEEK, FOWK, TWMH, FOMH, NONE ]
OBMandateRelatedInformation1{
MandateIdentification Identification_1string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Classification OBExternalMandateClassification1CodestringEnum:
[ FIXE, USGB, VARI ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
[ BONU, CASH, CBLK, CCRD, CGWV, CIPC, CONC, CORT, DCRD, DIVI, DVPM, EPAY, FCDT, FCIN, FCOL, GOVT, GP2P, HEDG, ICCP, IDCP, INTC, INTE, LBOX, LOAN, MP2B, MP2P, OTHR, PENS, RPRE, RRCT, RVPM, SALA, SECU, SSBE, SUPP, SWEP, TAXS, TOPG, TRAD, TREA, VATX, VOST, WHLD, ZABA ]
FirstPaymentDateTime string($date-time)
RecurringPaymentDateTime string($date-time)

The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

FinalPaymentDateTime string($date-time)
Frequency* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBFrequency6OBFrequency6{
description:

Regularity with which credit transfer instructions are to be created and processed

Type* OBFrequency6Codestring

OBFrequency6Code on External Codset Repo

Enum:
[ YEAR, FRTN, MNTH, QURT, MIAN, WEEK, FOWK, TWMH, FOMH, NONE ]
CountPerPeriod integer($int32)
example: 1

Number of instructions to be created and processed during the specified period .Specifies a frequency in terms of a count per period within a specified frequency type. Note: should not be used alongside PointInTime

PointInTime PointInTimestring
example: 00
maxLength: 2

Exact2NumericText - Further information on the exact point in time the event should take place. Specifies a frequency in terms of an exact point in time or moment within a specified frequency type. Note: should not be used alongside CountPerSide

}
Reason string
maxLength: 256
minLength: 1

Reason for the direct debit mandate to allow the user to distinguish between different mandates for the same creditor.

}
OBPaymentStatusReason{
StatusReasonCode string
minLength: 1
maxLength: 4
example: ERIN

Specifies the status reason in a code form For more information and enum values see `OBExternalStatusReason1Code here

StatusReasonDescription string
minLength: 1
maxLength: 500

Description supporting the StatusReasonCode.

Path string
minLength: 1
maxLength: 500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

}
OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
[ TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
[ TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID ]
OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
OBReferredDocumentInformation{
Code ExternalDocumentType1Codestring
minLength: 1
maxLength: 4

Specifies the document type as published in an external document type code list. For more information see ExternalDocumentType1Code in ISO_External_CodeSet here

Enum:
[ CINV, CNFA, CONT, CREN, DEBN, DISP, DNFA, HIRI, INVS, MSIN, PROF, PUOR, QUOT, SBIN, SPRR, TISH ]
Issuer string
maxLength: 35
minLength: 1

Identification of the issuer of the reference document type.

Number string
maxLength: 35
minLength: 1

Identification of the type specified for the referred document line.

RelatedDate string($date-time)

Date associated with the referred document line.

LineDetails [

Set of elements used to provide the content of the referred document line.

string]
}
OBRemittanceInformation2{
description:

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system

Structured [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformationStructuredOBRemittanceInformationStructured{
ReferredDocumentInformation [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBReferredDocumentInformationOBReferredDocumentInformation{
Code ExternalDocumentType1Codestring
minLength: 1
maxLength: 4

Specifies the document type as published in an external document type code list. For more information see ExternalDocumentType1Code in ISO_External_CodeSet here

Enum:
[ CINV, CNFA, CONT, CREN, DEBN, DISP, DNFA, HIRI, INVS, MSIN, PROF, PUOR, QUOT, SBIN, SPRR, TISH ]
Issuer string
maxLength: 35
minLength: 1

Identification of the issuer of the reference document type.

Number string
maxLength: 35
minLength: 1

Identification of the type specified for the referred document line.

RelatedDate string($date-time)

Date associated with the referred document line.

LineDetails [

Set of elements used to provide the content of the referred document line.

string]
}]
ReferredDocumentAmount integer($int32)

Provides details on the amounts of the referred document.

CreditorReferenceInformation {
description:

Reference information provided by the creditor to allow the identification of the underlying documents.

Code ExternalCreditorReferenceType1Codestring
minLength: 1
maxLength: 4

Specifies the type of creditor reference as published in an external creditor reference type code set. For more information see ExternalCreditorReferenceType1Code in ISO_External_CodeSet here

Enum:
Array [ 6 ]
Issuer string
minLength: 1
maxLength: 35

Entity that assigns the identification.

Reference string
minLength: 1
maxLength: 35

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.

}
Invoicer Identification_3string
example: 80200112344562
minLength: 1
maxLength: 256

Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor

Invoicee Identification_4string
example: 80200112344562
minLength: 1
maxLength: 256

Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.

TaxRemittance string
maxLength: 140
minLength: 1

Provides remittance information about a payment made for tax-related purposes.

AdditionalRemittanceInformation [
maxItems: 3

Additional information, in free text form, to complement the structured remittance information.

string
maxLength: 140
minLength: 1]
}]
Unstructured [

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

string
maxLength: 140
minLength: 1]
}
OBRemittanceInformationStructured{
ReferredDocumentInformation [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBReferredDocumentInformationOBReferredDocumentInformation{
Code ExternalDocumentType1Codestring
minLength: 1
maxLength: 4

Specifies the document type as published in an external document type code list. For more information see ExternalDocumentType1Code in ISO_External_CodeSet here

Enum:
[ CINV, CNFA, CONT, CREN, DEBN, DISP, DNFA, HIRI, INVS, MSIN, PROF, PUOR, QUOT, SBIN, SPRR, TISH ]
Issuer string
maxLength: 35
minLength: 1

Identification of the issuer of the reference document type.

Number string
maxLength: 35
minLength: 1

Identification of the type specified for the referred document line.

RelatedDate string($date-time)

Date associated with the referred document line.

LineDetails [

Set of elements used to provide the content of the referred document line.

string]
}]
ReferredDocumentAmount integer($int32)

Provides details on the amounts of the referred document.

CreditorReferenceInformation {
description:

Reference information provided by the creditor to allow the identification of the underlying documents.

Code ExternalCreditorReferenceType1Codestring
minLength: 1
maxLength: 4

Specifies the type of creditor reference as published in an external creditor reference type code set. For more information see ExternalCreditorReferenceType1Code in ISO_External_CodeSet here

Enum:
Array [ 6 ]
Issuer string
minLength: 1
maxLength: 35

Entity that assigns the identification.

Reference string
minLength: 1
maxLength: 35

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.

}
Invoicer Identification_3string
example: 80200112344562
minLength: 1
maxLength: 256

Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor

Invoicee Identification_4string
example: 80200112344562
minLength: 1
maxLength: 256

Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.

TaxRemittance string
maxLength: 140
minLength: 1

Provides remittance information about a payment made for tax-related purposes.

AdditionalRemittanceInformation [
maxItems: 3

Additional information, in free text form, to complement the structured remittance information.

string
maxLength: 140
minLength: 1]
}
OBRegulatoryAuthority2{
description:

Entity requiring the regulatory reporting information.

Name string
minLength: 1
maxLength: 140

Name of the entity requiring the regulatory reporting information.

CountryCode CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

}
OBRegulatoryReporting1{
description:

Information needed due to regulatory and statutory requirements

DebitCreditReportingIndicator string

Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction. For a full list of values reefer to OBExternalRegulatoryReportingType1Code in OB_Internal_CodeSet here

Enum:
[ CRED, DEBT, BOTH ]
Authority https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryAuthority2OBRegulatoryAuthority2{
description:

Entity requiring the regulatory reporting information.

Name string
minLength: 1
maxLength: 140

Name of the entity requiring the regulatory reporting information.

CountryCode CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

}
Details [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBStructuredRegulatoryReporting3OBStructuredRegulatoryReporting3{
description:

Set of elements used to provide details on the regulatory reporting information.

Type string
minLength: 1
maxLength: 35

Specifies the type of the information supplied in the regulatory reporting details

Date ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

Amount https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
description:

Amount of money associated with the charge type.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
Information [

Additional details that cater for specific domestic regulatory requirements.

string
minLength: 1
maxLength: 35]
}]
}
OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context, OBInternalPaymentContext1Code

Enum:
[ BillingGoodsAndServicesInAdvance, BillingGoodsAndServicesInArrears, EcommerceMerchantInitiatedPayment, FaceToFacePointOfSale, TransferToSelf, TransferToThirdParty ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentIndicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode ExternalPurpose1Codestring
minLength: 1
maxLength: 4

This is a partial list, For a full list see ExternalPurpose1Code here

Enum:
[ BKDF, BKFE, BKFM, BKIP, BKPP, CBLK, CDCB, CDCD, CDCS, CDDP, CDOC, CDQC, ETUP, FCOL, MTUP, ACCT, CASH, COLL, CSDB, DEPT, INTC, INTP, LIMA, NETT, BFWD, CCIR, CCPC, CCPM, CCSM, CRDS, CRPR, CRSP, CRTL, EQPT, EQUS, EXPT, EXTD, FIXI, FWBC, FWCC, FWSB, FWSC, MARG, MBSB, MBSC, MGCC, MGSC, OCCC, OPBC, OPCC, OPSB, OPSC, OPTN, OTCD, REPO, RPBC, RPCC, RPSB, RPSC, RVPO, SBSC, SCIE, SCIR, SCRP, SHBC, SHCC, SHSL, SLEB, SLOA, SWBC, SWCC, SWPT, SWSB, SWSC, TBAS, TBBC, TBCC, TRCP, AGRT, AREN, BEXP, BOCE, COMC, CPYR, GDDS, GDSV, GSCB, LICF, MP2B, POPE, ROYA, SCVE, SERV, SUBS, SUPP, TRAD, CHAR, COMT, MP2P, ECPG, ECPR, ECPU, EPAY, CLPR, COMP, DBTC, GOVI, HLRP, HLST, INPC, INPR, INSC, INSU, INTE, LBRI, LIFI, LOAN, LOAR, PENO, PPTI, RELG, RINP, TRFD, FORW, FXNT, ADMG, ADVA, BCDM, BCFG, BLDM, BNET, CBFF, CBFR, CCRD, CDBL, CFEE, CGDD, CORT, COST, CPKC, DCRD, DSMT, DVPM, EDUC, FACT, FAND, FCPM, FEES, GIFT, GOVT, ICCP, IDCP, IHRP, INSM, IVPT, MCDM, MCFG, MSVC, NOWS, OCDM, OCFG, OFEE, OTHR, PADD, PTSP, RCKE, RCPT, REBT, REFU, RENT, REOD, RIMB, RPNT, RRBN, RRCT, RRTP, RVPM, SLPI, SPLT, STDY, TBAN, TBIL, TCSC, TELI, TMPG, TPRI, TPRP, TRNC, TRVC, WEBI, IPAY, IPCA, IPDO, IPEA, IPEC, IPEW, IPPS, IPRT, IPU2, IPUW, ANNI, CAFI, CFDI, CMDT, DERI, DIVD, FREX, HEDG, INVS, PRME, SAVG, SECU, SEPI, TREA, UNIT, FNET, FUTR, ANTS, CVCF, DMEQ, DNTS, HLTC, HLTI, HSPC, ICRF, LTCF, MAFC, MARF, MDCS, VIEW, CDEP, SWFP, SWPP, SWRS, SWUF, ADCS, AEMP, ALLW, ALMY, BBSC, BECH, BENE, BONU, CCHD, COMM, CSLP, GFRP, GVEA, GVEB, GVEC, GVED, GWLT, HREC, PAYR, PEFC, PENS, PRCP, RHBS, SALA, SPSP, SSBE, LBIN, LCOL, LFEE, LMEQ, LMFI, LMRK, LREB, LREV, LSFL, ESTX, FWLV, GSTX, HSTX, INTX, NITX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, B112, BR12, TLRF, TLRR, AIRB, BUSB, FERB, RLWY, TRPT, CBTV, ELEC, ENRG, GASB, NWCH, NWCM, OTLC, PHON, UBIL, WTER, BOND, CABD, CAEQ, CBCR, DBCR, DICL, EQTS, FLCR, EFTC, EFTD, MOMA, RAPI, GAMB, LOTT, AMEX, SASW, AUCO, PCOM, PDEP, PLDS, PLRF, GAFA, GAHO, CPEN, DEPD, RETL, DEBT ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
[ BONU, CASH, CBLK, CCRD, CGWV, CIPC, CONC, CORT, DCRD, DIVI, DVPM, EPAY, FCDT, FCIN, FCOL, GOVT, GP2P, HEDG, ICCP, IDCP, INTC, INTE, LBOX, LOAN, MP2B, MP2P, OTHR, PENS, RPRE, RRCT, RVPM, SALA, SECU, SSBE, SUPP, SWEP, TAXS, TOPG, TRAD, TREA, VATX, VOST, WHLD, ZABA ]
BeneficiaryAccountType OBInternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
[ Business, BusinessSavingsAccount, Charity, Collection, Corporate, Ewallet, Government, Investment, ISA, JointPersonal, Pension, Personal, PersonalSavingsAccount, Premier, Wealth ]
DeliveryAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
OBSCASupportData1{
description:

Supporting Data provided by TPP, when requesting SCA Exemption.

RequestedSCAExemptionType string

This field allows a PISP to request specific SCA Exemption for a Payment Initiation. For a full list of values reefer to OBInternalSCAExemptionType1Code in OB_Internal_CodeSet here

Enum:
[ BillPayment, ContactlessTravel, EcommerceGoods, EcommerceServices, Kiosk, Parking, PartyToParty ]
AppliedAuthenticationApproach string
maxLength: 40

Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP For a full list of values refer to OBInternalAppliedAuthenticationApproach1Code in OB_Internal_CodeSet here

Enum:
[ CA, SCA ]
ReferencePaymentOrderId string
maxLength: 40
minLength: 1

If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId

}
OBStatusReason{
StatusReasonCode string
minLength: 1
maxLength: 4
example: ERIN

Specifies the status reason in a code form. For a full list of values refer to OBExternalStatusReason1Code in OB_Internal_CodeSet here

StatusReasonDescription string
minLength: 1
maxLength: 500

Description supporting the StatusReasonCode.

Path string
minLength: 1
maxLength: 500

Path is optional but relevant when the status reason refers to an object/field and hence conditional to provide JSON path.

}
OBStructuredRegulatoryReporting3{
description:

Set of elements used to provide details on the regulatory reporting information.

Type string
minLength: 1
maxLength: 35

Specifies the type of the information supplied in the regulatory reporting details

Date ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

Amount https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
description:

Amount of money associated with the charge type.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
Information [

Additional details that cater for specific domestic regulatory requirements.

string
minLength: 1
maxLength: 35]
}
OBSupplementaryData1{
description:

Additional information that can not be captured in the structured fields and/or any other specific block.

}
OBReadRefundAccountstring

Specifies to share the refund account details with PISP

Enum:
[ No, Yes ]
OBAuthorisationTypestring

Type of authorisation flow requested.

Enum:
[ Any, Single ]
OBInstructionPrioritystring

Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.

Enum:
[ Normal, Urgent ]
OBWriteDomestic2{
Data* {
ConsentId* string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

Initiation* {
description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.

InstructionIdentification* string
minLength: 1
maxLength: 35

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

EndToEndIdentification* string
minLength: 1
maxLength: 35

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.

LocalInstrument OBInternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. For a full list of values refer to OBInternalLocalInstrument1Code in OB_Internal_CodeSet here

InstructedAmount* {
description:

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
DebtorAccount {
description:

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
[ TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
CreditorAgent {
description:

Financial institution servicing an account for the creditor.

SchemeName OBInternalFinancialInstitutionIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list.

Identification Identification_1string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name Namestring
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
CreditorAccount* {
description:

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
[ TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
UltimateCreditor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateCreditor1OBUltimateCreditor1{
description:

Ultimate party to which an amount of money is due.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
UltimateDebtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateDebtor1OBUltimateDebtor1{
description:

Ultimate party that owes an amount of money to the (ultimate) creditor.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
RegulatoryReporting [
maxItems: 10
https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryReporting1OBRegulatoryReporting1{
description:

Information needed due to regulatory and statutory requirements

DebitCreditReportingIndicator string

Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction. For a full list of values reefer to OBExternalRegulatoryReportingType1Code in OB_Internal_CodeSet here

Enum:
[ CRED, DEBT, BOTH ]
Authority https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryAuthority2OBRegulatoryAuthority2{
description:

Entity requiring the regulatory reporting information.

Name string
minLength: 1
maxLength: 140

Name of the entity requiring the regulatory reporting information.

CountryCode CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

}
Details [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBStructuredRegulatoryReporting3OBStructuredRegulatoryReporting3{
description:

Set of elements used to provide details on the regulatory reporting information.

Type string
minLength: 1
maxLength: 35

Specifies the type of the information supplied in the regulatory reporting details

Date ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

Amount https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
description:

Amount of money associated with the charge type.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
Information [

Additional details that cater for specific domestic regulatory requirements.

string
minLength: 1
maxLength: 35]
}]
}]
RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformation2OBRemittanceInformation2{
description:

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system

Structured [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformationStructuredOBRemittanceInformationStructured{...}]
Unstructured [

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

string
maxLength: 140
minLength: 1]
}
SupplementaryData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSupplementaryData1OBSupplementaryData1{
description:

Additional information that can not be captured in the structured fields and/or any other specific block.

}
}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context, OBInternalPaymentContext1Code

Enum:
[ BillingGoodsAndServicesInAdvance, BillingGoodsAndServicesInArrears, EcommerceMerchantInitiatedPayment, FaceToFacePointOfSale, TransferToSelf, TransferToThirdParty ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentIndicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode ExternalPurpose1Codestring
minLength: 1
maxLength: 4

This is a partial list, For a full list see ExternalPurpose1Code here

Enum:
[ BKDF, BKFE, BKFM, BKIP, BKPP, CBLK, CDCB, CDCD, CDCS, CDDP, CDOC, CDQC, ETUP, FCOL, MTUP, ACCT, CASH, COLL, CSDB, DEPT, INTC, INTP, LIMA, NETT, BFWD, CCIR, CCPC, CCPM, CCSM, CRDS, CRPR, CRSP, CRTL, EQPT, EQUS, EXPT, EXTD, FIXI, FWBC, FWCC, FWSB, FWSC, MARG, MBSB, MBSC, MGCC, MGSC, OCCC, OPBC, OPCC, OPSB, OPSC, OPTN, OTCD, REPO, RPBC, RPCC, RPSB, RPSC, RVPO, SBSC, SCIE, SCIR, SCRP, SHBC, SHCC, SHSL, SLEB, SLOA, SWBC, SWCC, SWPT, SWSB, SWSC, TBAS, TBBC, TBCC, TRCP, AGRT, AREN, BEXP, BOCE, COMC, CPYR, GDDS, GDSV, GSCB, LICF, MP2B, POPE, ROYA, SCVE, SERV, SUBS, SUPP, TRAD, CHAR, COMT, MP2P, ECPG, ECPR, ECPU, EPAY, CLPR, COMP, DBTC, GOVI, HLRP, HLST, INPC, INPR, INSC, INSU, INTE, LBRI, LIFI, LOAN, LOAR, PENO, PPTI, RELG, RINP, TRFD, FORW, FXNT, ADMG, ADVA, BCDM, BCFG, BLDM, BNET, CBFF, CBFR, CCRD, CDBL, CFEE, CGDD, CORT, COST, CPKC, DCRD, DSMT, DVPM, EDUC, FACT, FAND, FCPM, FEES, GIFT, GOVT, ICCP, IDCP, IHRP, INSM, IVPT, MCDM, MCFG, MSVC, NOWS, OCDM, OCFG, OFEE, OTHR, PADD, PTSP, RCKE, RCPT, REBT, REFU, RENT, REOD, RIMB, RPNT, RRBN, RRCT, RRTP, RVPM, SLPI, SPLT, STDY, TBAN, TBIL, TCSC, TELI, TMPG, TPRI, TPRP, TRNC, TRVC, WEBI, IPAY, IPCA, IPDO, IPEA, IPEC, IPEW, IPPS, IPRT, IPU2, IPUW, ANNI, CAFI, CFDI, CMDT, DERI, DIVD, FREX, HEDG, INVS, PRME, SAVG, SECU, SEPI, TREA, UNIT, FNET, FUTR, ANTS, CVCF, DMEQ, DNTS, HLTC, HLTI, HSPC, ICRF, LTCF, MAFC, MARF, MDCS, VIEW, CDEP, SWFP, SWPP, SWRS, SWUF, ADCS, AEMP, ALLW, ALMY, BBSC, BECH, BENE, BONU, CCHD, COMM, CSLP, GFRP, GVEA, GVEB, GVEC, GVED, GWLT, HREC, PAYR, PEFC, PENS, PRCP, RHBS, SALA, SPSP, SSBE, LBIN, LCOL, LFEE, LMEQ, LMFI, LMRK, LREB, LREV, LSFL, ESTX, FWLV, GSTX, HSTX, INTX, NITX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, B112, BR12, TLRF, TLRR, AIRB, BUSB, FERB, RLWY, TRPT, CBTV, ELEC, ENRG, GASB, NWCH, NWCM, OTLC, PHON, UBIL, WTER, BOND, CABD, CAEQ, CBCR, DBCR, DICL, EQTS, FLCR, EFTC, EFTD, MOMA, RAPI, GAMB, LOTT, AMEX, SASW, AUCO, PCOM, PDEP, PLDS, PLRF, GAFA, GAHO, CPEN, DEPD, RETL, DEBT ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
[ BONU, CASH, CBLK, CCRD, CGWV, CIPC, CONC, CORT, DCRD, DIVI, DVPM, EPAY, FCDT, FCIN, FCOL, GOVT, GP2P, HEDG, ICCP, IDCP, INTC, INTE, LBOX, LOAN, MP2B, MP2P, OTHR, PENS, RPRE, RRCT, RVPM, SALA, SECU, SSBE, SUPP, SWEP, TAXS, TOPG, TRAD, TREA, VATX, VOST, WHLD, ZABA ]
BeneficiaryAccountType OBInternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
[ Business, BusinessSavingsAccount, Charity, Collection, Corporate, Ewallet, Government, Investment, ISA, JointPersonal, Pension, Personal, PersonalSavingsAccount, Premier, Wealth ]
DeliveryAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
}
OBWriteDomesticConsent4{
Data* {
ReadRefundAccount OBReadRefundAccountstring

Specifies to share the refund account details with PISP

Enum:
[ No, Yes ]
Initiation* {
description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.

InstructionIdentification* string
minLength: 1
maxLength: 35

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

EndToEndIdentification* string
minLength: 1
maxLength: 35

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.

LocalInstrument OBInternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. For a full list of values refer to OBInternalLocalInstrument1Code in OB_Internal_CodeSet here

InstructedAmount* {
description:

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
DebtorAccount {
description:

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
[ TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
CreditorAgent {
description:

Financial institution servicing an account for the creditor.

SchemeName OBInternalFinancialInstitutionIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list.

Identification Identification_1string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name Namestring
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
CreditorAccount* {
description:

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
[ TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
UltimateCreditor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateCreditor1OBUltimateCreditor1{
description:

Ultimate party to which an amount of money is due.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
UltimateDebtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateDebtor1OBUltimateDebtor1{
description:

Ultimate party that owes an amount of money to the (ultimate) creditor.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
RegulatoryReporting [
maxItems: 10
https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryReporting1OBRegulatoryReporting1{
description:

Information needed due to regulatory and statutory requirements

DebitCreditReportingIndicator string

Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction. For a full list of values reefer to OBExternalRegulatoryReportingType1Code in OB_Internal_CodeSet here

Enum:
[ CRED, DEBT, BOTH ]
Authority https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryAuthority2OBRegulatoryAuthority2{...}
Details [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBStructuredRegulatoryReporting3OBStructuredRegulatoryReporting3{
description:

Set of elements used to provide details on the regulatory reporting information.

Type string
minLength: 1
maxLength: 35

Specifies the type of the information supplied in the regulatory reporting details

Date ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

Amount https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{...}
Information [...]
}]
}]
RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformation2OBRemittanceInformation2{
description:

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system

Structured [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformationStructuredOBRemittanceInformationStructured{
ReferredDocumentInformation [...]
ReferredDocumentAmount integer($int32)

Provides details on the amounts of the referred document.

CreditorReferenceInformation {...}
Invoicer Identification_3string
example: 80200112344562
minLength: 1
maxLength: 256

Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor

Invoicee Identification_4string
example: 80200112344562
minLength: 1
maxLength: 256

Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.

TaxRemittance string
maxLength: 140
minLength: 1

Provides remittance information about a payment made for tax-related purposes.

AdditionalRemittanceInformation [...]
}]
Unstructured [

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

string
maxLength: 140
minLength: 1]
}
SupplementaryData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSupplementaryData1OBSupplementaryData1{
description:

Additional information that can not be captured in the structured fields and/or any other specific block.

}
}
Authorisation {
description:

The authorisation type request from the TPP.

AuthorisationType* OBAuthorisationTypestring

Type of authorisation flow requested.

Enum:
[ Any, Single ]
CompletionDateTime string($date-time)

Date and time at which the requested authorisation flow must be completed. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
SCASupportData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSCASupportData1OBSCASupportData1{
description:

Supporting Data provided by TPP, when requesting SCA Exemption.

RequestedSCAExemptionType string

This field allows a PISP to request specific SCA Exemption for a Payment Initiation. For a full list of values reefer to OBInternalSCAExemptionType1Code in OB_Internal_CodeSet here

Enum:
[ BillPayment, ContactlessTravel, EcommerceGoods, EcommerceServices, Kiosk, Parking, PartyToParty ]
AppliedAuthenticationApproach string
maxLength: 40

Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP For a full list of values refer to OBInternalAppliedAuthenticationApproach1Code in OB_Internal_CodeSet here

Enum:
[ CA, SCA ]
ReferencePaymentOrderId string
maxLength: 40
minLength: 1

If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId

}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context, OBInternalPaymentContext1Code

Enum:
Array [ 6 ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentIndicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode ExternalPurpose1Codestring
minLength: 1
maxLength: 4

This is a partial list, For a full list see ExternalPurpose1Code here

Enum:
[ BKDF, BKFE, BKFM, BKIP, BKPP, CBLK, CDCB, CDCD, CDCS, CDDP, CDOC, CDQC, ETUP, FCOL, MTUP, ACCT, CASH, COLL, CSDB, DEPT, INTC, INTP, LIMA, NETT, BFWD, CCIR, CCPC, CCPM, CCSM, CRDS, CRPR, CRSP, CRTL, EQPT, EQUS, EXPT, EXTD, FIXI, FWBC, FWCC, FWSB, FWSC, MARG, MBSB, MBSC, MGCC, MGSC, OCCC, OPBC, OPCC, OPSB, OPSC, OPTN, OTCD, REPO, RPBC, RPCC, RPSB, RPSC, RVPO, SBSC, SCIE, SCIR, SCRP, SHBC, SHCC, SHSL, SLEB, SLOA, SWBC, SWCC, SWPT, SWSB, SWSC, TBAS, TBBC, TBCC, TRCP, AGRT, AREN, BEXP, BOCE, COMC, CPYR, GDDS, GDSV, GSCB, LICF, MP2B, POPE, ROYA, SCVE, SERV, SUBS, SUPP, TRAD, CHAR, COMT, MP2P, ECPG, ECPR, ECPU, EPAY, CLPR, COMP, DBTC, GOVI, HLRP, HLST, INPC, INPR, INSC, INSU, INTE, LBRI, LIFI, LOAN, LOAR, PENO, PPTI, RELG, RINP, TRFD, FORW, FXNT, ADMG, ADVA, BCDM, BCFG, BLDM, BNET, CBFF, CBFR, CCRD, CDBL, CFEE, CGDD, CORT, COST, CPKC, DCRD, DSMT, DVPM, EDUC, FACT, FAND, FCPM, FEES, GIFT, GOVT, ICCP, IDCP, IHRP, INSM, IVPT, MCDM, MCFG, MSVC, NOWS, OCDM, OCFG, OFEE, OTHR, PADD, PTSP, RCKE, RCPT, REBT, REFU, RENT, REOD, RIMB, RPNT, RRBN, RRCT, RRTP, RVPM, SLPI, SPLT, STDY, TBAN, TBIL, TCSC, TELI, TMPG, TPRI, TPRP, TRNC, TRVC, WEBI, IPAY, IPCA, IPDO, IPEA, IPEC, IPEW, IPPS, IPRT, IPU2, IPUW, ANNI, CAFI, CFDI, CMDT, DERI, DIVD, FREX, HEDG, INVS, PRME, SAVG, SECU, SEPI, TREA, UNIT, FNET, FUTR, ANTS, CVCF, DMEQ, DNTS, HLTC, HLTI, HSPC, ICRF, LTCF, MAFC, MARF, MDCS, VIEW, CDEP, SWFP, SWPP, SWRS, SWUF, ADCS, AEMP, ALLW, ALMY, BBSC, BECH, BENE, BONU, CCHD, COMM, CSLP, GFRP, GVEA, GVEB, GVEC, GVED, GWLT, HREC, PAYR, PEFC, PENS, PRCP, RHBS, SALA, SPSP, SSBE, LBIN, LCOL, LFEE, LMEQ, LMFI, LMRK, LREB, LREV, LSFL, ESTX, FWLV, GSTX, HSTX, INTX, NITX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, B112, BR12, TLRF, TLRR, AIRB, BUSB, FERB, RLWY, TRPT, CBTV, ELEC, ENRG, GASB, NWCH, NWCM, OTLC, PHON, UBIL, WTER, BOND, CABD, CAEQ, CBCR, DBCR, DICL, EQTS, FLCR, EFTC, EFTD, MOMA, RAPI, GAMB, LOTT, AMEX, SASW, AUCO, PCOM, PDEP, PLDS, PLRF, GAFA, GAHO, CPEN, DEPD, RETL, DEBT ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
[ BONU, CASH, CBLK, CCRD, CGWV, CIPC, CONC, CORT, DCRD, DIVI, DVPM, EPAY, FCDT, FCIN, FCOL, GOVT, GP2P, HEDG, ICCP, IDCP, INTC, INTE, LBOX, LOAN, MP2B, MP2P, OTHR, PENS, RPRE, RRCT, RVPM, SALA, SECU, SSBE, SUPP, SWEP, TAXS, TOPG, TRAD, TREA, VATX, VOST, WHLD, ZABA ]
BeneficiaryAccountType OBInternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
[ Business, BusinessSavingsAccount, Charity, Collection, Corporate, Ewallet, Government, Investment, ISA, JointPersonal, Pension, Personal, PersonalSavingsAccount, Premier, Wealth ]
DeliveryAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
}
OBWriteDomesticConsentResponse5{
Data* {
ConsentId* string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime* string($date-time)

Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status* string

Specifies the status of consent resource in code form. For a full list of values refer to OBInternalConsentStatus1Code in OB_Internal_CodeSet here

Enum:
[ AWAU, RJCT, AUTH, COND ]
StatusReason [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBStatusReasonOBStatusReason{
StatusReasonCode string
minLength: 1
maxLength: 4
example: ERIN

Specifies the status reason in a code form. For a full list of values refer to OBExternalStatusReason1Code in OB_Internal_CodeSet here

StatusReasonDescription string
minLength: 1
maxLength: 500

Description supporting the StatusReasonCode.

Path string
minLength: 1
maxLength: 500

Path is optional but relevant when the status reason refers to an object/field and hence conditional to provide JSON path.

}]
StatusUpdateDateTime* string($date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ReadRefundAccount OBReadRefundAccountstring

Specifies to share the refund account details with PISP

Enum:
[ No, Yes ]
CutOffDateTime string($date-time)

Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedExecutionDateTime string($date-time)

Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedSettlementDateTime string($date-time)

Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Charges [{
description:

Set of elements used to provide details of a charge for the payment initiation.

ChargeBearer* OBInternalChargeBearerType1Codestring

Specifies which party/parties will bear the charges associated with the processing of the payment transaction. For a full list of values refer to OBInternalChargeBearerType1Code in OB_Internal_CodeSet here

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type* OBInternalPaymentChargeType1Codestring

Charge type, in a coded form. For a full list of values refer to OBInternalPaymentChargeType1Code in OB_Internal_CodeSet here

Amount* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
description:

Amount of money associated with the charge type.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
}]
Initiation* {
description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.

InstructionIdentification* string
minLength: 1
maxLength: 35

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

EndToEndIdentification* string
minLength: 1
maxLength: 35

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.

LocalInstrument OBInternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. For a full list of values refer to OBInternalLocalInstrument1Code in OB_Internal_CodeSet here

InstructedAmount* {
description:

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
DebtorAccount {
description:

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
[ TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
CreditorAgent {
description:

Financial institution servicing an account for the creditor.

SchemeName OBInternalFinancialInstitutionIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list.

Identification Identification_1string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name Namestring
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
CreditorAccount* {
description:

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
[ TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
UltimateCreditor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateCreditor1OBUltimateCreditor1{
description:

Ultimate party to which an amount of money is due.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
UltimateDebtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateDebtor1OBUltimateDebtor1{
description:

Ultimate party that owes an amount of money to the (ultimate) creditor.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
RegulatoryReporting [
maxItems: 10
https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryReporting1OBRegulatoryReporting1{
description:

Information needed due to regulatory and statutory requirements

DebitCreditReportingIndicator string

Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction. For a full list of values reefer to OBExternalRegulatoryReportingType1Code in OB_Internal_CodeSet here

Enum:
[ CRED, DEBT, BOTH ]
Authority https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryAuthority2OBRegulatoryAuthority2{...}
Details [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBStructuredRegulatoryReporting3OBStructuredRegulatoryReporting3{
description:

Set of elements used to provide details on the regulatory reporting information.

Type string
minLength: 1
maxLength: 35

Specifies the type of the information supplied in the regulatory reporting details

Date ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

Amount https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{...}
Information [...]
}]
}]
RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformation2OBRemittanceInformation2{
description:

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system

Structured [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformationStructuredOBRemittanceInformationStructured{...}]
Unstructured [

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

string
maxLength: 140
minLength: 1]
}
SupplementaryData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSupplementaryData1OBSupplementaryData1{
description:

Additional information that can not be captured in the structured fields and/or any other specific block.

}
}
Authorisation {
description:

The authorisation type request from the TPP.

AuthorisationType* OBAuthorisationTypestring

Type of authorisation flow requested.

Enum:
[ Any, Single ]
CompletionDateTime string($date-time)

Date and time at which the requested authorisation flow must be completed. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
SCASupportData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSCASupportData1OBSCASupportData1{
description:

Supporting Data provided by TPP, when requesting SCA Exemption.

RequestedSCAExemptionType string

This field allows a PISP to request specific SCA Exemption for a Payment Initiation. For a full list of values reefer to OBInternalSCAExemptionType1Code in OB_Internal_CodeSet here

Enum:
[ BillPayment, ContactlessTravel, EcommerceGoods, EcommerceServices, Kiosk, Parking, PartyToParty ]
AppliedAuthenticationApproach string
maxLength: 40

Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP For a full list of values refer to OBInternalAppliedAuthenticationApproach1Code in OB_Internal_CodeSet here

Enum:
[ CA, SCA ]
ReferencePaymentOrderId string
maxLength: 40
minLength: 1

If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId

}
Debtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBCashAccountDebtor4OBCashAccountDebtor4{
description:

^ Only included in the response if Data. ReadRefundAccount is set to Yes in the consent.

SchemeName string

^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBInternalAccountIdentification4Code

Identification string

^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text

Name string

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context, OBInternalPaymentContext1Code

Enum:
Array [ 6 ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentIndicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode ExternalPurpose1Codestring
minLength: 1
maxLength: 4

This is a partial list, For a full list see ExternalPurpose1Code here

Enum:
[ BKDF, BKFE, BKFM, BKIP, BKPP, CBLK, CDCB, CDCD, CDCS, CDDP, CDOC, CDQC, ETUP, FCOL, MTUP, ACCT, CASH, COLL, CSDB, DEPT, INTC, INTP, LIMA, NETT, BFWD, CCIR, CCPC, CCPM, CCSM, CRDS, CRPR, CRSP, CRTL, EQPT, EQUS, EXPT, EXTD, FIXI, FWBC, FWCC, FWSB, FWSC, MARG, MBSB, MBSC, MGCC, MGSC, OCCC, OPBC, OPCC, OPSB, OPSC, OPTN, OTCD, REPO, RPBC, RPCC, RPSB, RPSC, RVPO, SBSC, SCIE, SCIR, SCRP, SHBC, SHCC, SHSL, SLEB, SLOA, SWBC, SWCC, SWPT, SWSB, SWSC, TBAS, TBBC, TBCC, TRCP, AGRT, AREN, BEXP, BOCE, COMC, CPYR, GDDS, GDSV, GSCB, LICF, MP2B, POPE, ROYA, SCVE, SERV, SUBS, SUPP, TRAD, CHAR, COMT, MP2P, ECPG, ECPR, ECPU, EPAY, CLPR, COMP, DBTC, GOVI, HLRP, HLST, INPC, INPR, INSC, INSU, INTE, LBRI, LIFI, LOAN, LOAR, PENO, PPTI, RELG, RINP, TRFD, FORW, FXNT, ADMG, ADVA, BCDM, BCFG, BLDM, BNET, CBFF, CBFR, CCRD, CDBL, CFEE, CGDD, CORT, COST, CPKC, DCRD, DSMT, DVPM, EDUC, FACT, FAND, FCPM, FEES, GIFT, GOVT, ICCP, IDCP, IHRP, INSM, IVPT, MCDM, MCFG, MSVC, NOWS, OCDM, OCFG, OFEE, OTHR, PADD, PTSP, RCKE, RCPT, REBT, REFU, RENT, REOD, RIMB, RPNT, RRBN, RRCT, RRTP, RVPM, SLPI, SPLT, STDY, TBAN, TBIL, TCSC, TELI, TMPG, TPRI, TPRP, TRNC, TRVC, WEBI, IPAY, IPCA, IPDO, IPEA, IPEC, IPEW, IPPS, IPRT, IPU2, IPUW, ANNI, CAFI, CFDI, CMDT, DERI, DIVD, FREX, HEDG, INVS, PRME, SAVG, SECU, SEPI, TREA, UNIT, FNET, FUTR, ANTS, CVCF, DMEQ, DNTS, HLTC, HLTI, HSPC, ICRF, LTCF, MAFC, MARF, MDCS, VIEW, CDEP, SWFP, SWPP, SWRS, SWUF, ADCS, AEMP, ALLW, ALMY, BBSC, BECH, BENE, BONU, CCHD, COMM, CSLP, GFRP, GVEA, GVEB, GVEC, GVED, GWLT, HREC, PAYR, PEFC, PENS, PRCP, RHBS, SALA, SPSP, SSBE, LBIN, LCOL, LFEE, LMEQ, LMFI, LMRK, LREB, LREV, LSFL, ESTX, FWLV, GSTX, HSTX, INTX, NITX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, B112, BR12, TLRF, TLRR, AIRB, BUSB, FERB, RLWY, TRPT, CBTV, ELEC, ENRG, GASB, NWCH, NWCM, OTLC, PHON, UBIL, WTER, BOND, CABD, CAEQ, CBCR, DBCR, DICL, EQTS, FLCR, EFTC, EFTD, MOMA, RAPI, GAMB, LOTT, AMEX, SASW, AUCO, PCOM, PDEP, PLDS, PLRF, GAFA, GAHO, CPEN, DEPD, RETL, DEBT ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
[ BONU, CASH, CBLK, CCRD, CGWV, CIPC, CONC, CORT, DCRD, DIVI, DVPM, EPAY, FCDT, FCIN, FCOL, GOVT, GP2P, HEDG, ICCP, IDCP, INTC, INTE, LBOX, LOAN, MP2B, MP2P, OTHR, PENS, RPRE, RRCT, RVPM, SALA, SECU, SSBE, SUPP, SWEP, TAXS, TOPG, TRAD, TREA, VATX, VOST, WHLD, ZABA ]
BeneficiaryAccountType OBInternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
[ Business, BusinessSavingsAccount, Charity, Collection, Corporate, Ewallet, Government, Investment, ISA, JointPersonal, Pension, Personal, PersonalSavingsAccount, Premier, Wealth ]
DeliveryAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
Links https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/LinksLinks{
description:

Links relevant to the payload

Self* string($uri)
First string($uri)
Prev string($uri)
Next string($uri)
Last string($uri)
}
Meta https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/MetaMetaData{
description:

Meta Data relevant to the payload

TotalPages integer($int32)
FirstAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
OBWriteDomesticResponse5{
Data* {
DomesticPaymentId* string
minLength: 1
maxLength: 40

OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource.

ConsentId* string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime* string($date-time)

Date and time at which the message was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status* string

Specifies the status of the payment information group. For a full list of values refer to ExternalPaymentTransactionStatus1Code in OB_Internal_CodeSet here

Enum:
[ RCVD, PDNG, ACTC, PATC, ACCP, ACFC, ACSP, ACWC, ACSC, ACWP, ACCC, BLCK, RJCT ]
StatusUpdateDateTime* string($date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

StatusReason [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBStatusReasonOBStatusReason{
StatusReasonCode string
minLength: 1
maxLength: 4
example: ERIN

Specifies the status reason in a code form. For a full list of values refer to OBExternalStatusReason1Code in OB_Internal_CodeSet here

StatusReasonDescription string
minLength: 1
maxLength: 500

Description supporting the StatusReasonCode.

Path string
minLength: 1
maxLength: 500

Path is optional but relevant when the status reason refers to an object/field and hence conditional to provide JSON path.

}]
ExpectedExecutionDateTime string($date-time)

Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedSettlementDateTime string($date-time)

Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Refund {
description:

Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.

Account* {
description:

Provides the details to identify an account.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 350

Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

}
}
Charges [{
description:

Set of elements used to provide details of a charge for the payment initiation.

ChargeBearer* OBInternalChargeBearerType1Codestring

Specifies which party/parties will bear the charges associated with the processing of the payment transaction. For a full list of values refer to OBInternalChargeBearerType1Code in OB_Internal_CodeSet here

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type* OBInternalPaymentChargeType1Codestring

Charge type, in a coded form. For a full list of values refer to OBInternalPaymentChargeType1Code in OB_Internal_CodeSet here

Amount* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
description:

Amount of money associated with the charge type.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
}]
Initiation* {
description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment.

InstructionIdentification* string
minLength: 1
maxLength: 35

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

EndToEndIdentification* string
minLength: 1
maxLength: 35

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.

LocalInstrument OBInternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. For a full list of values refer to OBInternalLocalInstrument1Code in OB_Internal_CodeSet here

InstructedAmount* {
description:

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
DebtorAccount {
description:

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
[ TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
CreditorAgent {
description:

Financial institution servicing an account for the creditor.

SchemeName OBInternalFinancialInstitutionIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list.

Identification Identification_1string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name Namestring
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
CreditorAccount* {
description:

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
Array [ 21 ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
UltimateCreditor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateCreditor1OBUltimateCreditor1{
description:

Ultimate party to which an amount of money is due.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
UltimateDebtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateDebtor1OBUltimateDebtor1{
description:

Ultimate party that owes an amount of money to the (ultimate) creditor.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
RegulatoryReporting [
maxItems: 10
https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryReporting1OBRegulatoryReporting1{
description:

Information needed due to regulatory and statutory requirements

DebitCreditReportingIndicator string

Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction. For a full list of values reefer to OBExternalRegulatoryReportingType1Code in OB_Internal_CodeSet here

Enum:
[ CRED, DEBT, BOTH ]
Authority https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryAuthority2OBRegulatoryAuthority2{...}
Details [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBStructuredRegulatoryReporting3OBStructuredRegulatoryReporting3{
description:

Set of elements used to provide details on the regulatory reporting information.

Type string
minLength: 1
maxLength: 35

Specifies the type of the information supplied in the regulatory reporting details

Date ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

Amount https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{...}
Information [...]
}]
}]
RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformation2OBRemittanceInformation2{
description:

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system

Structured [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformationStructuredOBRemittanceInformationStructured{...}]
Unstructured [

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

string
maxLength: 140
minLength: 1]
}
SupplementaryData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSupplementaryData1OBSupplementaryData1{
description:

Additional information that can not be captured in the structured fields and/or any other specific block.

}
}
MultiAuthorisation {
description:

The multiple authorisation flow response from the ASPSP.

Status* string

Specifies the status of the authorisation flow in code form.

Enum:
[ AUTH, AWAF, RJCT ]
NumberRequired integer

Number of authorisations required for payment order (total required at the start of the multi authorisation journey).

NumberReceived integer

Number of authorisations received.

LastUpdateDateTime string($date-time)

Last date and time at the authorisation flow was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpirationDateTime string($date-time)

Date and time at which the requested authorisation flow must be completed. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
Debtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBCashAccountDebtor4OBCashAccountDebtor4{
description:

^ Only included in the response if Data. ReadRefundAccount is set to Yes in the consent.

SchemeName string

^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBInternalAccountIdentification4Code

Identification string

^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text

Name string

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

}
}
Links https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/LinksLinks{
description:

Links relevant to the payload

Self* string($uri)
First string($uri)
Prev string($uri)
Next string($uri)
Last string($uri)
}
Meta https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/MetaMetaData{
description:

Meta Data relevant to the payload

TotalPages integer($int32)
FirstAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
OBWriteDomesticScheduled2{
Data* {
ConsentId* string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

Initiation* {
description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.

InstructionIdentification* string
minLength: 1
maxLength: 35

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

EndToEndIdentification string
minLength: 1
maxLength: 35

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.

LocalInstrument OBInternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. For a full list of values refer to OBInternalLocalInstrument1Code in OB_Internal_CodeSet here

RequestedExecutionDateTime* string($date-time)

Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

InstructedAmount* {
description:

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
DebtorAccount {
description:

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
[ TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
CreditorAccount* {
description:

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
[ TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
UltimateCreditor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateCreditor1OBUltimateCreditor1{
description:

Ultimate party to which an amount of money is due.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
UltimateDebtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateDebtor1OBUltimateDebtor1{
description:

Ultimate party that owes an amount of money to the (ultimate) creditor.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
RegulatoryReporting [
maxItems: 10
https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryReporting1OBRegulatoryReporting1{...}]
RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformation2OBRemittanceInformation2{
description:

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system

Structured [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformationStructuredOBRemittanceInformationStructured{
ReferredDocumentInformation [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBReferredDocumentInformationOBReferredDocumentInformation{
Code ExternalDocumentType1Codestring
minLength: 1
maxLength: 4

Specifies the document type as published in an external document type code list. For more information see ExternalDocumentType1Code in ISO_External_CodeSet here

Enum:
Array [ 16 ]
Issuer string
maxLength: 35
minLength: 1

Identification of the issuer of the reference document type.

Number string
maxLength: 35
minLength: 1

Identification of the type specified for the referred document line.

RelatedDate string($date-time)

Date associated with the referred document line.

LineDetails [...]
}]
ReferredDocumentAmount integer($int32)

Provides details on the amounts of the referred document.

CreditorReferenceInformation {
description:

Reference information provided by the creditor to allow the identification of the underlying documents.

Code ExternalCreditorReferenceType1Codestring
minLength: 1
maxLength: 4

Specifies the type of creditor reference as published in an external creditor reference type code set. For more information see ExternalCreditorReferenceType1Code in ISO_External_CodeSet here

Enum:
Array [ 6 ]
Issuer string
minLength: 1
maxLength: 35

Entity that assigns the identification.

Reference string
minLength: 1
maxLength: 35

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.

}
Invoicer Identification_3string
example: 80200112344562
minLength: 1
maxLength: 256

Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor

Invoicee Identification_4string
example: 80200112344562
minLength: 1
maxLength: 256

Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.

TaxRemittance string
maxLength: 140
minLength: 1

Provides remittance information about a payment made for tax-related purposes.

AdditionalRemittanceInformation [
maxItems: 3

Additional information, in free text form, to complement the structured remittance information.

string
maxLength: 140
minLength: 1]
}]
Unstructured [

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

string
maxLength: 140
minLength: 1]
}
SupplementaryData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSupplementaryData1OBSupplementaryData1{
description:

Additional information that can not be captured in the structured fields and/or any other specific block.

}
}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context, OBInternalPaymentContext1Code

Enum:
[ BillingGoodsAndServicesInAdvance, BillingGoodsAndServicesInArrears, EcommerceMerchantInitiatedPayment, FaceToFacePointOfSale, TransferToSelf, TransferToThirdParty ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentIndicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode ExternalPurpose1Codestring
minLength: 1
maxLength: 4

This is a partial list, For a full list see ExternalPurpose1Code here

Enum:
[ BKDF, BKFE, BKFM, BKIP, BKPP, CBLK, CDCB, CDCD, CDCS, CDDP, CDOC, CDQC, ETUP, FCOL, MTUP, ACCT, CASH, COLL, CSDB, DEPT, INTC, INTP, LIMA, NETT, BFWD, CCIR, CCPC, CCPM, CCSM, CRDS, CRPR, CRSP, CRTL, EQPT, EQUS, EXPT, EXTD, FIXI, FWBC, FWCC, FWSB, FWSC, MARG, MBSB, MBSC, MGCC, MGSC, OCCC, OPBC, OPCC, OPSB, OPSC, OPTN, OTCD, REPO, RPBC, RPCC, RPSB, RPSC, RVPO, SBSC, SCIE, SCIR, SCRP, SHBC, SHCC, SHSL, SLEB, SLOA, SWBC, SWCC, SWPT, SWSB, SWSC, TBAS, TBBC, TBCC, TRCP, AGRT, AREN, BEXP, BOCE, COMC, CPYR, GDDS, GDSV, GSCB, LICF, MP2B, POPE, ROYA, SCVE, SERV, SUBS, SUPP, TRAD, CHAR, COMT, MP2P, ECPG, ECPR, ECPU, EPAY, CLPR, COMP, DBTC, GOVI, HLRP, HLST, INPC, INPR, INSC, INSU, INTE, LBRI, LIFI, LOAN, LOAR, PENO, PPTI, RELG, RINP, TRFD, FORW, FXNT, ADMG, ADVA, BCDM, BCFG, BLDM, BNET, CBFF, CBFR, CCRD, CDBL, CFEE, CGDD, CORT, COST, CPKC, DCRD, DSMT, DVPM, EDUC, FACT, FAND, FCPM, FEES, GIFT, GOVT, ICCP, IDCP, IHRP, INSM, IVPT, MCDM, MCFG, MSVC, NOWS, OCDM, OCFG, OFEE, OTHR, PADD, PTSP, RCKE, RCPT, REBT, REFU, RENT, REOD, RIMB, RPNT, RRBN, RRCT, RRTP, RVPM, SLPI, SPLT, STDY, TBAN, TBIL, TCSC, TELI, TMPG, TPRI, TPRP, TRNC, TRVC, WEBI, IPAY, IPCA, IPDO, IPEA, IPEC, IPEW, IPPS, IPRT, IPU2, IPUW, ANNI, CAFI, CFDI, CMDT, DERI, DIVD, FREX, HEDG, INVS, PRME, SAVG, SECU, SEPI, TREA, UNIT, FNET, FUTR, ANTS, CVCF, DMEQ, DNTS, HLTC, HLTI, HSPC, ICRF, LTCF, MAFC, MARF, MDCS, VIEW, CDEP, SWFP, SWPP, SWRS, SWUF, ADCS, AEMP, ALLW, ALMY, BBSC, BECH, BENE, BONU, CCHD, COMM, CSLP, GFRP, GVEA, GVEB, GVEC, GVED, GWLT, HREC, PAYR, PEFC, PENS, PRCP, RHBS, SALA, SPSP, SSBE, LBIN, LCOL, LFEE, LMEQ, LMFI, LMRK, LREB, LREV, LSFL, ESTX, FWLV, GSTX, HSTX, INTX, NITX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, B112, BR12, TLRF, TLRR, AIRB, BUSB, FERB, RLWY, TRPT, CBTV, ELEC, ENRG, GASB, NWCH, NWCM, OTLC, PHON, UBIL, WTER, BOND, CABD, CAEQ, CBCR, DBCR, DICL, EQTS, FLCR, EFTC, EFTD, MOMA, RAPI, GAMB, LOTT, AMEX, SASW, AUCO, PCOM, PDEP, PLDS, PLRF, GAFA, GAHO, CPEN, DEPD, RETL, DEBT ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
[ BONU, CASH, CBLK, CCRD, CGWV, CIPC, CONC, CORT, DCRD, DIVI, DVPM, EPAY, FCDT, FCIN, FCOL, GOVT, GP2P, HEDG, ICCP, IDCP, INTC, INTE, LBOX, LOAN, MP2B, MP2P, OTHR, PENS, RPRE, RRCT, RVPM, SALA, SECU, SSBE, SUPP, SWEP, TAXS, TOPG, TRAD, TREA, VATX, VOST, WHLD, ZABA ]
BeneficiaryAccountType OBInternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
[ Business, BusinessSavingsAccount, Charity, Collection, Corporate, Ewallet, Government, Investment, ISA, JointPersonal, Pension, Personal, PersonalSavingsAccount, Premier, Wealth ]
DeliveryAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
}
OBWriteDomesticScheduledConsent4{
Data* {
Permission* string

Specifies the Open Banking service request types. For a full list of values see OBInternalPermissions2Code in OB_Internal_CodeSet here

Enum:
[ Create ]
ReadRefundAccount OBReadRefundAccountstring

Specifies to share the refund account details with PISP

Enum:
[ No, Yes ]
Initiation* {
description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.

InstructionIdentification* string
minLength: 1
maxLength: 35

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

EndToEndIdentification string
minLength: 1
maxLength: 35

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.

LocalInstrument OBInternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. For a full list of values refer to OBInternalLocalInstrument1Code in OB_Internal_CodeSet here

RequestedExecutionDateTime* string($date-time)

Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

InstructedAmount* {
description:

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
DebtorAccount {
description:

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
Array [ 21 ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
CreditorAccount* {
description:

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
Array [ 21 ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
UltimateCreditor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateCreditor1OBUltimateCreditor1{
description:

Ultimate party to which an amount of money is due.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
UltimateDebtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateDebtor1OBUltimateDebtor1{
description:

Ultimate party that owes an amount of money to the (ultimate) creditor.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
RegulatoryReporting [
maxItems: 10
https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryReporting1OBRegulatoryReporting1{
description:

Information needed due to regulatory and statutory requirements

DebitCreditReportingIndicator string

Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction. For a full list of values reefer to OBExternalRegulatoryReportingType1Code in OB_Internal_CodeSet here

Enum:
[ CRED, DEBT, BOTH ]
Authority https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryAuthority2OBRegulatoryAuthority2{...}
Details [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBStructuredRegulatoryReporting3OBStructuredRegulatoryReporting3{
description:

Set of elements used to provide details on the regulatory reporting information.

Type string
minLength: 1
maxLength: 35

Specifies the type of the information supplied in the regulatory reporting details

Date ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

Amount https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{...}
Information [...]
}]
}]
RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformation2OBRemittanceInformation2{
description:

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system

Structured [...]
Unstructured [...]
}
SupplementaryData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSupplementaryData1OBSupplementaryData1{
description:

Additional information that can not be captured in the structured fields and/or any other specific block.

}
}
Authorisation {
description:

The authorisation type request from the TPP.

AuthorisationType* OBAuthorisationTypestring

Type of authorisation flow requested.

Enum:
Array [ 2 ]
CompletionDateTime string($date-time)

Date and time at which the requested authorisation flow must be completed. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
SCASupportData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSCASupportData1OBSCASupportData1{
description:

Supporting Data provided by TPP, when requesting SCA Exemption.

RequestedSCAExemptionType string

This field allows a PISP to request specific SCA Exemption for a Payment Initiation. For a full list of values reefer to OBInternalSCAExemptionType1Code in OB_Internal_CodeSet here

Enum:
Array [ 7 ]
AppliedAuthenticationApproach string
maxLength: 40

Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP For a full list of values refer to OBInternalAppliedAuthenticationApproach1Code in OB_Internal_CodeSet here

Enum:
Array [ 2 ]
ReferencePaymentOrderId string
maxLength: 40
minLength: 1

If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId

}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context, OBInternalPaymentContext1Code

Enum:
Array [ 6 ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentIndicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode ExternalPurpose1Codestring
minLength: 1
maxLength: 4

This is a partial list, For a full list see ExternalPurpose1Code here

Enum:
Array [ 328 ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
Array [ 44 ]
BeneficiaryAccountType OBInternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
Array [ 15 ]
DeliveryAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
}
OBWriteDomesticScheduledConsentResponse5{
Data* {
ConsentId* string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime* string($date-time)

Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status* string

Specifies the status of consent resource in code form. For a full list of values see OBInternalConsentStatus1Code in ISO_External_CodeSet here

Enum:
[ AUTH, AWAU, COND, RJCT ]
StatusUpdateDateTime* string($date-time)

Date and time at which the consent resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

StatusReason [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBStatusReasonOBStatusReason{...}]
Permission* string

Specifies the Open Banking service request types. For a full list of values see OBInternalPermissions2Code in OB_Internal_CodeSet here

Enum:
[ Create ]
ReadRefundAccount OBReadRefundAccountstring

Specifies to share the refund account details with PISP

Enum:
[ No, Yes ]
CutOffDateTime string($date-time)

Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedExecutionDateTime string($date-time)

Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedSettlementDateTime string($date-time)

Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Charges [{
description:

Set of elements used to provide details of a charge for the payment initiation.

ChargeBearer* OBInternalChargeBearerType1Codestring

Specifies which party/parties will bear the charges associated with the processing of the payment transaction. For a full list of values refer to OBInternalChargeBearerType1Code in OB_Internal_CodeSet here

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type* OBInternalPaymentChargeType1Codestring

Charge type, in a coded form. For a full list of values refer to OBInternalPaymentChargeType1Code in OB_Internal_CodeSet here

Amount* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
description:

Amount of money associated with the charge type.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
}]
Initiation* {
description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.

InstructionIdentification* string
minLength: 1
maxLength: 35

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

EndToEndIdentification string
minLength: 1
maxLength: 35

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.

LocalInstrument OBInternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. For a full list of values refer to OBInternalLocalInstrument1Code in OB_Internal_CodeSet here

RequestedExecutionDateTime* string($date-time)

Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

InstructedAmount* {
description:

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
DebtorAccount {
description:

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
Array [ 21 ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
CreditorAccount* {
description:

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{...}
}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [...]
}
UltimateCreditor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateCreditor1OBUltimateCreditor1{
description:

Ultimate party to which an amount of money is due.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
UltimateDebtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateDebtor1OBUltimateDebtor1{
description:

Ultimate party that owes an amount of money to the (ultimate) creditor.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
RegulatoryReporting [
maxItems: 10
https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryReporting1OBRegulatoryReporting1{
description:

Information needed due to regulatory and statutory requirements

DebitCreditReportingIndicator string

Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction. For a full list of values reefer to OBExternalRegulatoryReportingType1Code in OB_Internal_CodeSet here

Enum:
[ CRED, DEBT, BOTH ]
Authority https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryAuthority2OBRegulatoryAuthority2{...}
Details [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBStructuredRegulatoryReporting3OBStructuredRegulatoryReporting3{...}]
}]
RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformation2OBRemittanceInformation2{
description:

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system

Structured [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformationStructuredOBRemittanceInformationStructured{
ReferredDocumentInformation [...]
ReferredDocumentAmount integer($int32)

Provides details on the amounts of the referred document.

CreditorReferenceInformation {...}
Invoicer Identification_3string
example: 80200112344562
minLength: 1
maxLength: 256

Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor

Invoicee Identification_4string
example: 80200112344562
minLength: 1
maxLength: 256

Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.

TaxRemittance string
maxLength: 140
minLength: 1

Provides remittance information about a payment made for tax-related purposes.

AdditionalRemittanceInformation [...]
}]
Unstructured [

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

string
maxLength: 140
minLength: 1]
}
SupplementaryData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSupplementaryData1OBSupplementaryData1{
description:

Additional information that can not be captured in the structured fields and/or any other specific block.

}
}
Authorisation {
description:

The authorisation type request from the TPP.

AuthorisationType* OBAuthorisationTypestring

Type of authorisation flow requested.

Enum:
[ Any, Single ]
CompletionDateTime string($date-time)

Date and time at which the requested authorisation flow must be completed. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
SCASupportData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSCASupportData1OBSCASupportData1{
description:

Supporting Data provided by TPP, when requesting SCA Exemption.

RequestedSCAExemptionType string

This field allows a PISP to request specific SCA Exemption for a Payment Initiation. For a full list of values reefer to OBInternalSCAExemptionType1Code in OB_Internal_CodeSet here

Enum:
Array [ 7 ]
AppliedAuthenticationApproach string
maxLength: 40

Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP For a full list of values refer to OBInternalAppliedAuthenticationApproach1Code in OB_Internal_CodeSet here

Enum:
Array [ 2 ]
ReferencePaymentOrderId string
maxLength: 40
minLength: 1

If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId

}
Debtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBCashAccountDebtor4OBCashAccountDebtor4{
description:

^ Only included in the response if Data. ReadRefundAccount is set to Yes in the consent.

SchemeName string

^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBInternalAccountIdentification4Code

Identification string

^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text

Name string

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context, OBInternalPaymentContext1Code

Enum:
Array [ 6 ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentIndicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode ExternalPurpose1Codestring
minLength: 1
maxLength: 4

This is a partial list, For a full list see ExternalPurpose1Code here

Enum:
Array [ 328 ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
Array [ 44 ]
BeneficiaryAccountType OBInternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
Array [ 15 ]
DeliveryAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
Links https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/LinksLinks{
description:

Links relevant to the payload

Self* string($uri)
First string($uri)
Prev string($uri)
Next string($uri)
Last string($uri)
}
Meta https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/MetaMetaData{
description:

Meta Data relevant to the payload

TotalPages integer($int32)
FirstAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
OBWriteDomesticScheduledResponse5{
Data* {
DomesticScheduledPaymentId* string
minLength: 1
maxLength: 40

OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule payment resource.

ConsentId* string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime* string($date-time)

Date and time at which the message was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status* string

Specifies the status of the payment order resource. For a full list of values see ExternalPaymentTransactionStatus1Code in OB_Internal_CodeSet here

Enum:
[ RCVD, CANC, PDNG, ACTC, PATC, ACCP, ACFC, ACSP, ACWC, ACSC, ACWP, ACCC, BLCK, RJCT ]
StatusUpdateDateTime* string($date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

StatusReason [...]
ExpectedExecutionDateTime string($date-time)

Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedSettlementDateTime string($date-time)

Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Refund {
description:

Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.

Account* {
description:

Provides the details to identify an account.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 350

Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

}
}
Charges [{
description:

Set of elements used to provide details of a charge for the payment initiation.

ChargeBearer* OBInternalChargeBearerType1Codestring

Specifies which party/parties will bear the charges associated with the processing of the payment transaction. For a full list of values refer to OBInternalChargeBearerType1Code in OB_Internal_CodeSet here

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type* OBInternalPaymentChargeType1Codestring

Charge type, in a coded form. For a full list of values refer to OBInternalPaymentChargeType1Code in OB_Internal_CodeSet here

Amount* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
description:

Amount of money associated with the charge type.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
}]
Initiation* {
description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment.

InstructionIdentification* string
minLength: 1
maxLength: 35

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

EndToEndIdentification string
minLength: 1
maxLength: 35

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.

LocalInstrument OBInternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. For a full list of values refer to OBInternalLocalInstrument1Code in OB_Internal_CodeSet here

RequestedExecutionDateTime* string($date-time)

Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

InstructedAmount* {
description:

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
DebtorAccount {
description:

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
Array [ 21 ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
CreditorAccount* {
description:

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
Array [ 21 ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [...]
}
UltimateCreditor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateCreditor1OBUltimateCreditor1{
description:

Ultimate party to which an amount of money is due.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
UltimateDebtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateDebtor1OBUltimateDebtor1{
description:

Ultimate party that owes an amount of money to the (ultimate) creditor.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
RegulatoryReporting [
maxItems: 10
https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryReporting1OBRegulatoryReporting1{
description:

Information needed due to regulatory and statutory requirements

DebitCreditReportingIndicator string

Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction. For a full list of values reefer to OBExternalRegulatoryReportingType1Code in OB_Internal_CodeSet here

Enum:
[ CRED, DEBT, BOTH ]
Authority https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryAuthority2OBRegulatoryAuthority2{...}
Details [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBStructuredRegulatoryReporting3OBStructuredRegulatoryReporting3{
description:

Set of elements used to provide details on the regulatory reporting information.

Type string
minLength: 1
maxLength: 35

Specifies the type of the information supplied in the regulatory reporting details

Date ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

Amount https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{...}
Information [...]
}]
}]
RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformation2OBRemittanceInformation2{
description:

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system

Structured [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformationStructuredOBRemittanceInformationStructured{...}]
Unstructured [

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

string
maxLength: 140
minLength: 1]
}
SupplementaryData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSupplementaryData1OBSupplementaryData1{
description:

Additional information that can not be captured in the structured fields and/or any other specific block.

}
}
MultiAuthorisation {
description:

The multiple authorisation flow response from the ASPSP.

Status* string

Specifies the status of the authorisation flow in code form.

Enum:
Array [ 3 ]
NumberRequired integer

Number of authorisations required for payment order (total required at the start of the multi authorisation journey).

NumberReceived integer

Number of authorisations received.

LastUpdateDateTime string($date-time)

Last date and time at the authorisation flow was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpirationDateTime string($date-time)

Date and time at which the requested authorisation flow must be completed. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
Debtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBCashAccountDebtor4OBCashAccountDebtor4{
description:

^ Only included in the response if Data. ReadRefundAccount is set to Yes in the consent.

SchemeName string

^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBInternalAccountIdentification4Code

Identification string

^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text

Name string

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

}
}
Links https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/LinksLinks{
description:

Links relevant to the payload

Self* string($uri)
First string($uri)
Prev string($uri)
Next string($uri)
Last string($uri)
}
Meta https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/MetaMetaData{
description:

Meta Data relevant to the payload

TotalPages integer($int32)
FirstAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
OBWriteDomesticStandingOrder3{
Data* {
ConsentId* string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

Initiation* {...}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context, OBInternalPaymentContext1Code

Enum:
Array [ 6 ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentIndicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode ExternalPurpose1Codestring
minLength: 1
maxLength: 4

This is a partial list, For a full list see ExternalPurpose1Code here

Enum:
Array [ 328 ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
Array [ 44 ]
BeneficiaryAccountType OBInternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
Array [ 15 ]
DeliveryAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
}
OBWriteDomesticStandingOrderConsent5{
Data* {
Permission* string

Specifies the Open Banking service request types. For a full list of values see OBInternalPermissions2Code in OB_Internal_CodeSet here

Enum:
Array [ 1 ]
ReadRefundAccount OBReadRefundAccountstring

Specifies to share the refund account details with PISP

Enum:
Array [ 2 ]
Initiation* {
description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.

RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformation2OBRemittanceInformation2{...}
NumberOfPayments NumberOfPaymentsstring
minLength: 1
maxLength: 35

Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.

FirstPaymentAmount* {
description:

The amount of the first Standing Order

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
RecurringPaymentAmount {
description:

The amount of the recurring Standing Order

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
FinalPaymentAmount {
description:

The amount of the final Standing Order

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
DebtorAccount {
description:

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{...}
}
CreditorAccount* {
description:

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
[ TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
UltimateCreditor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateCreditor1OBUltimateCreditor1{
description:

Ultimate party to which an amount of money is due.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
UltimateDebtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateDebtor1OBUltimateDebtor1{
description:

Ultimate party that owes an amount of money to the (ultimate) creditor.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [...]
}
}
RegulatoryReporting [...]
MandateRelatedInformation* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBMandateRelatedInformation1OBMandateRelatedInformation1{
MandateIdentification Identification_1string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Classification OBExternalMandateClassification1CodestringEnum:
Array [ 3 ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
Array [ 44 ]
FirstPaymentDateTime string($date-time)
RecurringPaymentDateTime string($date-time)

The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

FinalPaymentDateTime string($date-time)
Frequency* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBFrequency6OBFrequency6{
description:

Regularity with which credit transfer instructions are to be created and processed

Type* OBFrequency6Codestring

OBFrequency6Code on External Codset Repo

Enum:
Array [ 10 ]
CountPerPeriod integer($int32)
example: 1

Number of instructions to be created and processed during the specified period .Specifies a frequency in terms of a count per period within a specified frequency type. Note: should not be used alongside PointInTime

PointInTime PointInTimestring
example: 00
maxLength: 2

Exact2NumericText - Further information on the exact point in time the event should take place. Specifies a frequency in terms of an exact point in time or moment within a specified frequency type. Note: should not be used alongside CountPerSide

}
Reason string
maxLength: 256
minLength: 1

Reason for the direct debit mandate to allow the user to distinguish between different mandates for the same creditor.

}
SupplementaryData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSupplementaryData1OBSupplementaryData1{
description:

Additional information that can not be captured in the structured fields and/or any other specific block.

}
}
Authorisation {
description:

The authorisation type request from the TPP.

AuthorisationType* OBAuthorisationTypestring

Type of authorisation flow requested.

Enum:
Array [ 2 ]
CompletionDateTime string($date-time)

Date and time at which the requested authorisation flow must be completed. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
SCASupportData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSCASupportData1OBSCASupportData1{
description:

Supporting Data provided by TPP, when requesting SCA Exemption.

RequestedSCAExemptionType string

This field allows a PISP to request specific SCA Exemption for a Payment Initiation. For a full list of values reefer to OBInternalSCAExemptionType1Code in OB_Internal_CodeSet here

Enum:
Array [ 7 ]
AppliedAuthenticationApproach string
maxLength: 40

Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP For a full list of values refer to OBInternalAppliedAuthenticationApproach1Code in OB_Internal_CodeSet here

Enum:
Array [ 2 ]
ReferencePaymentOrderId string
maxLength: 40
minLength: 1

If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId

}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context, OBInternalPaymentContext1Code

Enum:
Array [ 6 ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentIndicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode ExternalPurpose1Codestring
minLength: 1
maxLength: 4

This is a partial list, For a full list see ExternalPurpose1Code here

Enum:
Array [ 328 ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
Array [ 44 ]
BeneficiaryAccountType OBInternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
Array [ 15 ]
DeliveryAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
}
OBWriteDomesticStandingOrderConsentResponse6{
Data* {
ConsentId* string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime* string($date-time)

Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status* string

Specifies the status of consent resource in code form. For a full list of values see OBInternalConsentStatus1Code in ISO_External_CodeSet here

Enum:
Array [ 4 ]
StatusUpdateDateTime* string($date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

StatusReason [...]
Permission* string

Specifies the Open Banking service request types. For a full list of values see OBInternalPermissions2Code in OB_Internal_CodeSet here

Enum:
Array [ 1 ]
ReadRefundAccount OBReadRefundAccountstring

Specifies to share the refund account details with PISP

Enum:
Array [ 2 ]
CutOffDateTime string($date-time)

Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Charges [{
description:

Set of elements used to provide details of a charge for the payment initiation.

ChargeBearer* OBInternalChargeBearerType1Codestring

Specifies which party/parties will bear the charges associated with the processing of the payment transaction. For a full list of values refer to OBInternalChargeBearerType1Code in OB_Internal_CodeSet here

Enum:
Array [ 4 ]
Type* OBInternalPaymentChargeType1Codestring

Charge type, in a coded form. For a full list of values refer to OBInternalPaymentChargeType1Code in OB_Internal_CodeSet here

Amount* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
description:

Amount of money associated with the charge type.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
}]
Initiation* {
description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order.

RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformation2OBRemittanceInformation2{...}
NumberOfPayments NumberOfPaymentsstring
minLength: 1
maxLength: 35

Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.

FirstPaymentAmount* {
description:

The amount of the first Standing Order

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
RecurringPaymentAmount {
description:

The amount of the recurring Standing Order

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
FinalPaymentAmount {...}
DebtorAccount {...}
CreditorAccount* {...}
UltimateCreditor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateCreditor1OBUltimateCreditor1{...}
UltimateDebtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateDebtor1OBUltimateDebtor1{...}
RegulatoryReporting [...]
MandateRelatedInformation* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBMandateRelatedInformation1OBMandateRelatedInformation1{
MandateIdentification Identification_1string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Classification OBExternalMandateClassification1CodestringEnum:
Array [ 3 ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
Array [ 44 ]
FirstPaymentDateTime string($date-time)
RecurringPaymentDateTime string($date-time)

The date on which the first recurring payment for a Standing Order schedule will be made. Usage: This must be populated only if the first recurring date is different to the first payment date. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

FinalPaymentDateTime string($date-time)
Frequency* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBFrequency6OBFrequency6{...}
Reason string
maxLength: 256
minLength: 1

Reason for the direct debit mandate to allow the user to distinguish between different mandates for the same creditor.

}
SupplementaryData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSupplementaryData1OBSupplementaryData1{
description:

Additional information that can not be captured in the structured fields and/or any other specific block.

}
}
Authorisation {
description:

The authorisation type request from the TPP.

AuthorisationType* OBAuthorisationTypestring

Type of authorisation flow requested.

Enum:
Array [ 2 ]
CompletionDateTime string($date-time)

Date and time at which the requested authorisation flow must be completed. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
SCASupportData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSCASupportData1OBSCASupportData1{
description:

Supporting Data provided by TPP, when requesting SCA Exemption.

RequestedSCAExemptionType string

This field allows a PISP to request specific SCA Exemption for a Payment Initiation. For a full list of values reefer to OBInternalSCAExemptionType1Code in OB_Internal_CodeSet here

Enum:
Array [ 7 ]
AppliedAuthenticationApproach string
maxLength: 40

Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP For a full list of values refer to OBInternalAppliedAuthenticationApproach1Code in OB_Internal_CodeSet here

Enum:
Array [ 2 ]
ReferencePaymentOrderId string
maxLength: 40
minLength: 1

If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId

}
Debtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBCashAccountDebtor4OBCashAccountDebtor4{
description:

^ Only included in the response if Data. ReadRefundAccount is set to Yes in the consent.

SchemeName string

^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBInternalAccountIdentification4Code

Identification string

^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text

Name string

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context, OBInternalPaymentContext1Code

Enum:
Array [ 6 ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentIndicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode ExternalPurpose1Codestring
minLength: 1
maxLength: 4

This is a partial list, For a full list see ExternalPurpose1Code here

Enum:
Array [ 328 ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
Array [ 44 ]
BeneficiaryAccountType OBInternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
Array [ 15 ]
DeliveryAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
Links https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/LinksLinks{
description:

Links relevant to the payload

Self* string($uri)
First string($uri)
Prev string($uri)
Next string($uri)
Last string($uri)
}
Meta https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/MetaMetaData{
description:

Meta Data relevant to the payload

TotalPages integer($int32)
FirstAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
OBWriteDomesticStandingOrderResponse6{
Data* {
DomesticStandingOrderId* string
minLength: 1
maxLength: 40

OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic standing order resource.

ConsentId* string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime* string($date-time)

Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status* string

Specifies the status of the payment order resource. For a full list of values see ExternalPaymentTransactionStatus1Code in OB_Internal_CodeSet here

Enum:
Array [ 8 ]
StatusUpdateDateTime* string($date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

StatusReason [...]
Refund {...}
Charges [...]
Initiation* {...}
MultiAuthorisation {...}
Debtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBCashAccountDebtor4OBCashAccountDebtor4{...}
}
Links https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/LinksLinks{
description:

Links relevant to the payload

Self* string($uri)
First string($uri)
Prev string($uri)
Next string($uri)
Last string($uri)
}
Meta https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/MetaMetaData{
description:

Meta Data relevant to the payload

TotalPages integer($int32)
FirstAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
OBWriteFile2{
Data* {
ConsentId* string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

Initiation* {
description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.

FileType* string

Specifies the payment file type.

FileHash* string
minLength: 1
maxLength: 44

A base64 encoding of a SHA256 hash of the file to be uploaded.

FileReference string
minLength: 1
maxLength: 40

Reference for the file.

NumberOfTransactions string
pattern: [0-9]{1,15}

Number of individual transactions contained in the payment information group.

ControlSum number

Total of all individual amounts included in the group, irrespective of currencies.

RequestedExecutionDateTime string($date-time)

Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LocalInstrument OBInternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. For a full list of values refer to OBInternalLocalInstrument1Code in OB_Internal_CodeSet here

CreditorAgent {...}
DebtorAccount {...}
UltimateDebtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateDebtor1OBUltimateDebtor1{...}
RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformation2OBRemittanceInformation2{...}
SupplementaryData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSupplementaryData1OBSupplementaryData1{...}
}
}
}
OBWriteFileConsent3{
Data* {
Initiation* {
description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.

FileType* string

Specifies the payment file type.

FileHash* string
minLength: 1
maxLength: 44

A base64 encoding of a SHA256 hash of the file to be uploaded.

FileReference string
minLength: 1
maxLength: 40

Reference for the file.

NumberOfTransactions string
pattern: [0-9]{1,15}

Number of individual transactions contained in the payment information group.

ControlSum number

Total of all individual amounts included in the group, irrespective of currencies.

RequestedExecutionDateTime string($date-time)

Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LocalInstrument OBInternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. For a full list of values refer to OBInternalLocalInstrument1Code in OB_Internal_CodeSet here

CreditorAgent {...}
DebtorAccount {...}
UltimateDebtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateDebtor1OBUltimateDebtor1{...}
RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformation2OBRemittanceInformation2{...}
SupplementaryData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSupplementaryData1OBSupplementaryData1{...}
}
Authorisation {
description:

The authorisation type request from the TPP.

AuthorisationType* OBAuthorisationTypestring

Type of authorisation flow requested.

Enum:
Array [ 2 ]
CompletionDateTime string($date-time)

Date and time at which the requested authorisation flow must be completed. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
SCASupportData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSCASupportData1OBSCASupportData1{
description:

Supporting Data provided by TPP, when requesting SCA Exemption.

RequestedSCAExemptionType string

This field allows a PISP to request specific SCA Exemption for a Payment Initiation. For a full list of values reefer to OBInternalSCAExemptionType1Code in OB_Internal_CodeSet here

Enum:
Array [ 7 ]
AppliedAuthenticationApproach string
maxLength: 40

Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP For a full list of values refer to OBInternalAppliedAuthenticationApproach1Code in OB_Internal_CodeSet here

Enum:
Array [ 2 ]
ReferencePaymentOrderId string
maxLength: 40
minLength: 1

If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId

}
}
}
OBWriteFileConsentResponse4{
Data* {
ConsentId* string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime* string($date-time)

Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status* string

Specifies the status of consent resource in code form.

Enum:
Array [ 5 ]
StatusReason [...]
StatusUpdateDateTime* string($date-time)

Date and time at which the consent resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

CutOffDateTime string($date-time)

Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Charges [...]
Initiation* {...}
Authorisation {...}
SCASupportData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSCASupportData1OBSCASupportData1{...}
Debtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBCashAccountDebtor4OBCashAccountDebtor4{...}
}
Links https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/LinksLinks{
description:

Links relevant to the payload

Self* string($uri)
First string($uri)
Prev string($uri)
Next string($uri)
Last string($uri)
}
Meta https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/MetaMetaData{
description:

Meta Data relevant to the payload

TotalPages integer($int32)
FirstAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
OBWriteFileResponse3{
Data* {
FilePaymentId* string
minLength: 1
maxLength: 40

OB: Unique identification as assigned by the ASPSP to uniquely identify the file payment resource.

ConsentId* string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime* string($date-time)

Date and time at which the message was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status* string

Specifies the status of the payment order resource. See ExternalPaymentTransactionStatus1Code in OB_Internal_CodeSet here for more information.

Enum:
Array [ 5 ]
StatusUpdateDateTime* string($date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

StatusReason [...]
Charges [...]
Initiation* {...}
MultiAuthorisation {...}
Debtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBCashAccountDebtor4OBCashAccountDebtor4{...}
}
Links https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/LinksLinks{
description:

Links relevant to the payload

Self* string($uri)
First string($uri)
Prev string($uri)
Next string($uri)
Last string($uri)
}
Meta https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/MetaMetaData{
description:

Meta Data relevant to the payload

TotalPages integer($int32)
FirstAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
OBWriteFundsConfirmationResponse1{
Data* {
FundsAvailableResult {...}
SupplementaryData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSupplementaryData1OBSupplementaryData1{...}
}
Links https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/LinksLinks{
description:

Links relevant to the payload

Self* string($uri)
First string($uri)
Prev string($uri)
Next string($uri)
Last string($uri)
}
Meta https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/MetaMetaData{
description:

Meta Data relevant to the payload

TotalPages integer($int32)
FirstAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
OBWriteInternational3{
Data* {
ConsentId* string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

Initiation* {...}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context, OBInternalPaymentContext1Code

Enum:
Array [ 6 ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentIndicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode ExternalPurpose1Codestring
minLength: 1
maxLength: 4

This is a partial list, For a full list see ExternalPurpose1Code here

Enum:
Array [ 328 ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
Array [ 44 ]
BeneficiaryAccountType OBInternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
Array [ 15 ]
DeliveryAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
}
OBWriteInternationalConsent5{
Data* {
ReadRefundAccount OBReadRefundAccountstring

Specifies to share the refund account details with PISP

Enum:
Array [ 2 ]
Initiation* {...}
Authorisation {...}
SCASupportData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSCASupportData1OBSCASupportData1{...}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context, OBInternalPaymentContext1Code

Enum:
Array [ 6 ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentIndicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode ExternalPurpose1Codestring
minLength: 1
maxLength: 4

This is a partial list, For a full list see ExternalPurpose1Code here

Enum:
Array [ 328 ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
Array [ 44 ]
BeneficiaryAccountType OBInternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
Array [ 15 ]
DeliveryAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
}
OBWriteInternationalConsentResponse6{
Data* {
ConsentId* string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime* string($date-time)

Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status* string

Specifies the status of consent resource in code form.

Enum:
Array [ 4 ]
StatusReason [...]
StatusUpdateDateTime* string($date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ReadRefundAccount OBReadRefundAccountstring

Specifies to share the refund account details with PISP

Enum:
Array [ 2 ]
CutOffDateTime string($date-time)

Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedExecutionDateTime string($date-time)

Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedSettlementDateTime string($date-time)

Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Charges [...]
ExchangeRateInformation {...}
Initiation* {...}
Authorisation {...}
SCASupportData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSCASupportData1OBSCASupportData1{...}
Debtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBCashAccountDebtor4OBCashAccountDebtor4{...}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context, OBInternalPaymentContext1Code

Enum:
Array [ 6 ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentIndicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode ExternalPurpose1Codestring
minLength: 1
maxLength: 4

This is a partial list, For a full list see ExternalPurpose1Code here

Enum:
Array [ 328 ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
Array [ 44 ]
BeneficiaryAccountType OBInternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
Array [ 15 ]
DeliveryAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
Links https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/LinksLinks{
description:

Links relevant to the payload

Self* string($uri)
First string($uri)
Prev string($uri)
Next string($uri)
Last string($uri)
}
Meta https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/MetaMetaData{
description:

Meta Data relevant to the payload

TotalPages integer($int32)
FirstAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
OBWriteInternationalResponse5{
Data* {
InternationalPaymentId* string
minLength: 1
maxLength: 40

OB: Unique identification as assigned by the ASPSP to uniquely identify the international payment resource.

ConsentId* string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime* string($date-time)

Date and time at which the message was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status* string

Specifies the status of the payment information group.

Enum:
Array [ 13 ]
StatusUpdateDateTime* string($date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

StatusReason [...]
ExpectedExecutionDateTime string($date-time)

Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedSettlementDateTime string($date-time)

Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Refund {...}
Charges [...]
ExchangeRateInformation {...}
Initiation* {...}
MultiAuthorisation {...}
Debtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBCashAccountDebtor4OBCashAccountDebtor4{...}
}
Links https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/LinksLinks{
description:

Links relevant to the payload

Self* string($uri)
First string($uri)
Prev string($uri)
Next string($uri)
Last string($uri)
}
Meta https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/MetaMetaData{
description:

Meta Data relevant to the payload

TotalPages integer($int32)
FirstAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
OBWriteInternationalScheduled3{
Data* {
ConsentId* string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

Initiation* {...}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context, OBInternalPaymentContext1Code

Enum:
Array [ 6 ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentIndicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode ExternalPurpose1Codestring
minLength: 1
maxLength: 4

This is a partial list, For a full list see ExternalPurpose1Code here

Enum:
Array [ 328 ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
Array [ 44 ]
BeneficiaryAccountType OBInternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
Array [ 15 ]
DeliveryAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
}
OBWriteInternationalScheduledConsent5{
Data* {
Permission* string

Specifies the Open Banking service request types.

Enum:
Array [ 1 ]
ReadRefundAccount OBReadRefundAccountstring

Specifies to share the refund account details with PISP

Enum:
Array [ 2 ]
Initiation* {...}
Authorisation {...}
SCASupportData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSCASupportData1OBSCASupportData1{...}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context, OBInternalPaymentContext1Code

Enum:
Array [ 6 ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentIndicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode ExternalPurpose1Codestring
minLength: 1
maxLength: 4

This is a partial list, For a full list see ExternalPurpose1Code here

Enum:
Array [ 328 ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
Array [ 44 ]
BeneficiaryAccountType OBInternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
Array [ 15 ]
DeliveryAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
}
OBWriteInternationalScheduledConsentResponse6{
Data* {
ConsentId* string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime* string($date-time)

Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status* string

Specifies the status of consent resource in code form.

Enum:
[ AWAU, RJCT, AUTH, COND ]
StatusReason [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBStatusReasonOBStatusReason{
StatusReasonCode string
minLength: 1
maxLength: 4
example: ERIN

Specifies the status reason in a code form. For a full list of values refer to OBExternalStatusReason1Code in OB_Internal_CodeSet here

StatusReasonDescription string
minLength: 1
maxLength: 500

Description supporting the StatusReasonCode.

Path string
minLength: 1
maxLength: 500

Path is optional but relevant when the status reason refers to an object/field and hence conditional to provide JSON path.

}]
StatusUpdateDateTime* string($date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Permission* string

Specifies the Open Banking service request types.

Enum:
[ Create ]
ReadRefundAccount OBReadRefundAccountstring

Specifies to share the refund account details with PISP

Enum:
[ No, Yes ]
CutOffDateTime string($date-time)

Specified cut-off date and time for the payment consent. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedExecutionDateTime string($date-time)

Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedSettlementDateTime string($date-time)

Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Charges [{...}]
ExchangeRateInformation {
description:

Further detailed information on the exchange rate that has been used in the payment transaction.

UnitCurrency* string
pattern: ^[A-Z]{3,3}$

Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.

ExchangeRate* number

The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.

RateType* string

Specifies the type used to complete the currency exchange.

Enum:
Array [ 3 ]
ContractIdentification string
minLength: 1
maxLength: 256

Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

ExpirationDateTime string($date-time)

Specified date and time the exchange rate agreement will expire. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
Initiation* {
description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.

InstructionIdentification* string
minLength: 1
maxLength: 35

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

EndToEndIdentification string
minLength: 1
maxLength: 35

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.

LocalInstrument OBInternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. For a full list of values refer to OBInternalLocalInstrument1Code in OB_Internal_CodeSet here

InstructionPriority OBInstructionPrioritystring

Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.

Enum:
[ Normal, Urgent ]
ExtendedPurpose string
minLength: 1
maxLength: 140

Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.

ChargeBearer OBInternalChargeBearerType1Codestring

Specifies which party/parties will bear the charges associated with the processing of the payment transaction. For a full list of values refer to OBInternalChargeBearerType1Code in OB_Internal_CodeSet here

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
RequestedExecutionDateTime* string($date-time)

Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

CurrencyOfTransfer* string
pattern: ^[A-Z]{3,3}$

Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.

DestinationCountryCode string
pattern: [A-Z]{2,2}

Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

InstructedAmount* {
description:

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
ExchangeRateInformation {
description:

Provides details on the currency exchange rate and contract.

UnitCurrency* string
pattern: ^[A-Z]{3,3}$

Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.

ExchangeRate number

The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.

RateType* string

Specifies the type used to complete the currency exchange.

Enum:
Array [ 3 ]
ContractIdentification string
minLength: 1
maxLength: 256

Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

}
DebtorAccount {
description:

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
Array [ 21 ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
Creditor {
description:

Party to which an amount of money is due.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
CreditorAgent {
description:

Financial institution servicing an account for the creditor.

SchemeName OBInternalFinancialInstitutionIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list.

Identification Identification_1string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name Namestring
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
CreditorAccount* {
description:

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
Array [ 21 ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
UltimateCreditor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateCreditor1OBUltimateCreditor1{
description:

Ultimate party to which an amount of money is due.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
UltimateDebtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateDebtor1OBUltimateDebtor1{
description:

Ultimate party that owes an amount of money to the (ultimate) creditor.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [...]
}
}
RegulatoryReporting [
maxItems: 10
https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryReporting1OBRegulatoryReporting1{
description:

Information needed due to regulatory and statutory requirements

DebitCreditReportingIndicator string

Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction. For a full list of values reefer to OBExternalRegulatoryReportingType1Code in OB_Internal_CodeSet here

Enum:
[ CRED, DEBT, BOTH ]
Authority https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryAuthority2OBRegulatoryAuthority2{...}
Details [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBStructuredRegulatoryReporting3OBStructuredRegulatoryReporting3{...}]
}]
RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformation2OBRemittanceInformation2{
description:

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system

Structured [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformationStructuredOBRemittanceInformationStructured{...}]
Unstructured [

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

string
maxLength: 140
minLength: 1]
}
SupplementaryData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSupplementaryData1OBSupplementaryData1{
description:

Additional information that can not be captured in the structured fields and/or any other specific block.

}
}
Authorisation {
description:

The authorisation type request from the TPP.

AuthorisationType* OBAuthorisationTypestring

Type of authorisation flow requested.

Enum:
[ Any, Single ]
CompletionDateTime string($date-time)

Date and time at which the requested authorisation flow must be completed. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
SCASupportData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSCASupportData1OBSCASupportData1{
description:

Supporting Data provided by TPP, when requesting SCA Exemption.

RequestedSCAExemptionType string

This field allows a PISP to request specific SCA Exemption for a Payment Initiation. For a full list of values reefer to OBInternalSCAExemptionType1Code in OB_Internal_CodeSet here

Enum:
Array [ 7 ]
AppliedAuthenticationApproach string
maxLength: 40

Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP For a full list of values refer to OBInternalAppliedAuthenticationApproach1Code in OB_Internal_CodeSet here

Enum:
[ CA, SCA ]
ReferencePaymentOrderId string
maxLength: 40
minLength: 1

If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId

}
Debtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBCashAccountDebtor4OBCashAccountDebtor4{
description:

^ Only included in the response if Data. ReadRefundAccount is set to Yes in the consent.

SchemeName string

^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBInternalAccountIdentification4Code

Identification string

^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text

Name string

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context, OBInternalPaymentContext1Code

Enum:
[ BillingGoodsAndServicesInAdvance, BillingGoodsAndServicesInArrears, EcommerceMerchantInitiatedPayment, FaceToFacePointOfSale, TransferToSelf, TransferToThirdParty ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentIndicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode ExternalPurpose1Codestring
minLength: 1
maxLength: 4

This is a partial list, For a full list see ExternalPurpose1Code here

Enum:
[ BKDF, BKFE, BKFM, BKIP, BKPP, CBLK, CDCB, CDCD, CDCS, CDDP, CDOC, CDQC, ETUP, FCOL, MTUP, ACCT, CASH, COLL, CSDB, DEPT, INTC, INTP, LIMA, NETT, BFWD, CCIR, CCPC, CCPM, CCSM, CRDS, CRPR, CRSP, CRTL, EQPT, EQUS, EXPT, EXTD, FIXI, FWBC, FWCC, FWSB, FWSC, MARG, MBSB, MBSC, MGCC, MGSC, OCCC, OPBC, OPCC, OPSB, OPSC, OPTN, OTCD, REPO, RPBC, RPCC, RPSB, RPSC, RVPO, SBSC, SCIE, SCIR, SCRP, SHBC, SHCC, SHSL, SLEB, SLOA, SWBC, SWCC, SWPT, SWSB, SWSC, TBAS, TBBC, TBCC, TRCP, AGRT, AREN, BEXP, BOCE, COMC, CPYR, GDDS, GDSV, GSCB, LICF, MP2B, POPE, ROYA, SCVE, SERV, SUBS, SUPP, TRAD, CHAR, COMT, MP2P, ECPG, ECPR, ECPU, EPAY, CLPR, COMP, DBTC, GOVI, HLRP, HLST, INPC, INPR, INSC, INSU, INTE, LBRI, LIFI, LOAN, LOAR, PENO, PPTI, RELG, RINP, TRFD, FORW, FXNT, ADMG, ADVA, BCDM, BCFG, BLDM, BNET, CBFF, CBFR, CCRD, CDBL, CFEE, CGDD, CORT, COST, CPKC, DCRD, DSMT, DVPM, EDUC, FACT, FAND, FCPM, FEES, GIFT, GOVT, ICCP, IDCP, IHRP, INSM, IVPT, MCDM, MCFG, MSVC, NOWS, OCDM, OCFG, OFEE, OTHR, PADD, PTSP, RCKE, RCPT, REBT, REFU, RENT, REOD, RIMB, RPNT, RRBN, RRCT, RRTP, RVPM, SLPI, SPLT, STDY, TBAN, TBIL, TCSC, TELI, TMPG, TPRI, TPRP, TRNC, TRVC, WEBI, IPAY, IPCA, IPDO, IPEA, IPEC, IPEW, IPPS, IPRT, IPU2, IPUW, ANNI, CAFI, CFDI, CMDT, DERI, DIVD, FREX, HEDG, INVS, PRME, SAVG, SECU, SEPI, TREA, UNIT, FNET, FUTR, ANTS, CVCF, DMEQ, DNTS, HLTC, HLTI, HSPC, ICRF, LTCF, MAFC, MARF, MDCS, VIEW, CDEP, SWFP, SWPP, SWRS, SWUF, ADCS, AEMP, ALLW, ALMY, BBSC, BECH, BENE, BONU, CCHD, COMM, CSLP, GFRP, GVEA, GVEB, GVEC, GVED, GWLT, HREC, PAYR, PEFC, PENS, PRCP, RHBS, SALA, SPSP, SSBE, LBIN, LCOL, LFEE, LMEQ, LMFI, LMRK, LREB, LREV, LSFL, ESTX, FWLV, GSTX, HSTX, INTX, NITX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, B112, BR12, TLRF, TLRR, AIRB, BUSB, FERB, RLWY, TRPT, CBTV, ELEC, ENRG, GASB, NWCH, NWCM, OTLC, PHON, UBIL, WTER, BOND, CABD, CAEQ, CBCR, DBCR, DICL, EQTS, FLCR, EFTC, EFTD, MOMA, RAPI, GAMB, LOTT, AMEX, SASW, AUCO, PCOM, PDEP, PLDS, PLRF, GAFA, GAHO, CPEN, DEPD, RETL, DEBT ]
CategoryPurposeCode ExternalCategoryPurpose1Codestring

Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code here

Enum:
[ BONU, CASH, CBLK, CCRD, CGWV, CIPC, CONC, CORT, DCRD, DIVI, DVPM, EPAY, FCDT, FCIN, FCOL, GOVT, GP2P, HEDG, ICCP, IDCP, INTC, INTE, LBOX, LOAN, MP2B, MP2P, OTHR, PENS, RPRE, RRCT, RVPM, SALA, SECU, SSBE, SUPP, SWEP, TAXS, TOPG, TRAD, TREA, VATX, VOST, WHLD, ZABA ]
BeneficiaryAccountType OBInternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
[ Business, BusinessSavingsAccount, Charity, Collection, Corporate, Ewallet, Government, Investment, ISA, JointPersonal, Pension, Personal, PersonalSavingsAccount, Premier, Wealth ]
DeliveryAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
Links https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/LinksLinks{
description:

Links relevant to the payload

Self* string($uri)
First string($uri)
Prev string($uri)
Next string($uri)
Last string($uri)
}
Meta https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/MetaMetaData{
description:

Meta Data relevant to the payload

TotalPages integer($int32)
FirstAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
OBWriteInternationalScheduledResponse6{
Data* {
InternationalScheduledPaymentId* string
minLength: 1
maxLength: 40

OB: Unique identification as assigned by the ASPSP to uniquely identify the international scheduled payment resource.

ConsentId* string
minLength: 1
maxLength: 128

OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime* string($date-time)

Date and time at which the message was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Status* string

Specifies the status of the payment order resource.

Enum:
[ RCVD, CANC, PDNG, ACTC, PATC, ACCP, ACFC, ACSP, ACWC, ACSC, ACWP, ACCC, BLCK, RJCT ]
StatusUpdateDateTime* string($date-time)

Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

StatusReason [...]
ExpectedExecutionDateTime string($date-time)

Expected execution date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpectedSettlementDateTime string($date-time)

Expected settlement date and time for the payment resource. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Refund {
Creditor {
description:

Party to which an amount of money is due.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
Agent {
description:

Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.

SchemeName OBInternalFinancialInstitutionIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list.

Identification Identification_1string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name Namestring
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressType2Codestring

Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code here.

Enum:
[ BIZZ, DLVY, MLTO, PBOX, ADDR, HOME, CORR, STAT ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

BuildingName BuildingNamestring
minLength: 1
maxLength: 140

Name of a referenced building.

Floor Floorstring
minLength: 1
maxLength: 70

Number that identifies the level within a building

UnitNumber UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Room Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

PostBox PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

TownLocationName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

DistrictName DistrictNamestring
minLength: 1
maxLength: 140

Number that of the regional area, known as a district, which forms part of an address

CareOf CareOfstring
minLength: 1
maxLength: 140

The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
Account* {
description:

Provides the details to identify an account.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 350

Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

}
}
Charges [{
description:

Set of elements used to provide details of a charge for the payment initiation.

ChargeBearer* OBInternalChargeBearerType1Codestring

Specifies which party/parties will bear the charges associated with the processing of the payment transaction. For a full list of values refer to OBInternalChargeBearerType1Code in OB_Internal_CodeSet here

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type* OBInternalPaymentChargeType1Codestring

Charge type, in a coded form. For a full list of values refer to OBInternalPaymentChargeType1Code in OB_Internal_CodeSet here

Amount* https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
description:

Amount of money associated with the charge type.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
}]
ExchangeRateInformation {
description:

Further detailed information on the exchange rate that has been used in the payment transaction.

UnitCurrency* string
pattern: ^[A-Z]{3,3}$

Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.

ExchangeRate* number

The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.

RateType* string

Specifies the type used to complete the currency exchange.

Enum:
[ Actual, Agreed, Indicative ]
ContractIdentification string
minLength: 1
maxLength: 256

Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

ExpirationDateTime string($date-time)

Specified date and time the exchange rate agreement will expire. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
Initiation* {
description:

The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.

InstructionIdentification* string
minLength: 1
maxLength: 35

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

EndToEndIdentification string
minLength: 1
maxLength: 35

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.

LocalInstrument OBInternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. For a full list of values refer to OBInternalLocalInstrument1Code in OB_Internal_CodeSet here

InstructionPriority OBInstructionPrioritystring

Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.

Enum:
[ Normal, Urgent ]
ExtendedPurpose string
minLength: 1
maxLength: 140

Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.

ChargeBearer OBInternalChargeBearerType1Codestring

Specifies which party/parties will bear the charges associated with the processing of the payment transaction. For a full list of values refer to OBInternalChargeBearerType1Code in OB_Internal_CodeSet here

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
RequestedExecutionDateTime* string($date-time)

Date at which the initiating party requests the clearing agent to process the payment. Usage: This is the date on which the debtor's account is to be debited. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

CurrencyOfTransfer* string
pattern: ^[A-Z]{3,3}$

Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.

DestinationCountryCode string
pattern: [A-Z]{2,2}

Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

InstructedAmount* {
description:

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
pattern: ^[A-Z]{3,3}$

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
ExchangeRateInformation {
description:

Provides details on the currency exchange rate and contract.

UnitCurrency* string
pattern: ^[A-Z]{3,3}$

Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.

ExchangeRate number

The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.

RateType* string

Specifies the type used to complete the currency exchange.

Enum:
[ Actual, Agreed, Indicative ]
ContractIdentification string
minLength: 1
maxLength: 256

Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.

}
DebtorAccount {
description:

Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
Array [ 21 ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
Creditor {...}
CreditorAgent {
description:

Financial institution servicing an account for the creditor.

SchemeName OBInternalFinancialInstitutionIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list.

Identification Identification_1string
minLength: 1
maxLength: 35

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name Namestring
minLength: 1
maxLength: 140

Name by which an agent is known and which is usually used to identify that agent.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
CreditorAccount* {
description:

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

SchemeName* OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

Identification* Identification_0string
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 70

The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.

SecondaryIdentification SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

Proxy https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBProxy1OBProxy1{
description:

Specifies an alternate assumed name for the identification of the account.

Identification* string
minLength: 1
maxLength: 2048

Identification used to indicate the account identification under another specified name.

Code* ExternalProxyAccountType1Codestring

Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see ExternalProxyAccountType1Code in ISO_External_CodeSet here

Enum:
Array [ 21 ]
Type string
minLength: 1
maxLength: 35

Type of the proxy identification.

}
}
UltimateCreditor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateCreditor1OBUltimateCreditor1{
description:

Ultimate party to which an amount of money is due.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
UltimateDebtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBUltimateDebtor1OBUltimateDebtor1{
description:

Ultimate party that owes an amount of money to the (ultimate) creditor.

Name string
minLength: 1
maxLength: 70

Name by which a party is known and which is usually used to identify that party.

Identification string
minLength: 1
maxLength: 256

Identification assigned by an institution.

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

SchemeName OBInternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in OB_Internal_CodeSet here

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBPostalAddress7OBPostalAddress7{...}
}
RegulatoryReporting [
maxItems: 10
https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryReporting1OBRegulatoryReporting1{
description:

Information needed due to regulatory and statutory requirements

DebitCreditReportingIndicator string

Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction. For a full list of values reefer to OBExternalRegulatoryReportingType1Code in OB_Internal_CodeSet here

Enum:
[ CRED, DEBT, BOTH ]
Authority https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRegulatoryAuthority2OBRegulatoryAuthority2{...}
Details [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBStructuredRegulatoryReporting3OBStructuredRegulatoryReporting3{
description:

Set of elements used to provide details on the regulatory reporting information.

Type string
minLength: 1
maxLength: 35

Specifies the type of the information supplied in the regulatory reporting details

Date ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

Country CountryCodestring
pattern: ^[A-Z]{2,2}$

Nation with its own government.

Amount https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{...}
Information [...]
}]
}]
RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformation2OBRemittanceInformation2{
description:

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system

Structured [https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBRemittanceInformationStructuredOBRemittanceInformationStructured{...}]
Unstructured [

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

string
maxLength: 140
minLength: 1]
}
SupplementaryData https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBSupplementaryData1OBSupplementaryData1{
description:

Additional information that can not be captured in the structured fields and/or any other specific block.

}
}
MultiAuthorisation {
description:

The multiple authorisation flow response from the ASPSP.

Status* string

Specifies the status of the authorisation flow in code form.

Enum:
Array [ 3 ]
NumberRequired integer

Number of authorisations required for payment order (total required at the start of the multi authorisation journey).

NumberReceived integer

Number of authorisations received.

LastUpdateDateTime string($date-time)

Last date and time at the authorisation flow was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

ExpirationDateTime string($date-time)

Date and time at which the requested authorisation flow must be completed. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
Debtor https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/OBCashAccountDebtor4OBCashAccountDebtor4{
description:

^ Only included in the response if Data. ReadRefundAccount is set to Yes in the consent.

SchemeName string

^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBInternalAccountIdentification4Code

Identification string

^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text

Name string

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text

LEI LEIstring
minLength: 1
maxLength: 20
pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}

Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

}
}
Links https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/LinksLinks{
description:

Links relevant to the payload

Self* string($uri)
First string($uri)
Prev string($uri)
Next string($uri)
Last string($uri)
}
Meta https://api.sandbox.natwest.com/devportal/upload/file/4766944?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDQ0MzYsImlhdCI6MTc1MDE0NDEzNiwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiJjYjc2NzdkNS1mODIxLTQwNGMtYTE5MC02ZDc4MmM1MzJmMWYiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjM5MDI1NzgtYjRhNS00ZDY0LWJiMDQtZTBiNWM2N2RlOWMwIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.HuKOjDMvZt6JXZyjdTt-AgcfHJJAx0OAALIk1lL0lW2vl0buJk-wDBQ_RbMEGIpro5C4LwI1KMIkT3mOYVvObXOolEEowvxnubzWHor0j73k05_Y-O7JiMp_Arxf5bEztzjjwUXHgPbDi1GPpOAO7byj0eeaNZ2bxYjNQXPyOfgrlcCbEgRUTYeAMHrFHxhjCAZvrQbzTEmgZNuCSvi6xWPK-zJWCWXo47wEJcSZnXPrRfHp3vhHjEbPUiExfveiBA5e5QsL_tlMcrZcjWMmLlYTXbjKMO6hes44bf-tiG34aA00RJ2GtpzASsofjSWVp_b3Tskib0jp7N_gpyfg8A#/components/schemas/MetaMetaData{
description:

Meta Data relevant to the payload

TotalPages integer($int32)
FirstAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

LastAvailableDateTime ISODateTimestring($date-time)

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

}
}
PostBoxstring
minLength: 1
maxLength: 16

Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.

PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

Roomstring
minLength: 1
maxLength: 70

Information that locates and identifies a room to form part of an address

SecondaryIdentificationstring
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).

StreetNamestring
minLength: 1
maxLength: 140

Name of a street or thoroughfare.

SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

Timestring($time)

Time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: T10:43:07+00:00

TownNamestring
minLength: 1
maxLength: 140

Name of a built-up area, with defined boundaries, and a local government.

UnitNumberstring
minLength: 1
maxLength: 16

Number that identifies the unit of a specific address .

Powered by Oolys
Your session is about to expire
You will be automatically logged out in 59 seconds.
Do you want to extend your session?